sapin

package module

v1.1.0 Latest Latest Go to latest Published: Nov 23, 2015 License: MIT Imports: 4 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/moul/sapin

Links

Open Source Insights

README ¶

sapin

🎄 drawing a christmas tree in Go

Demo

http://sapin-as-a-service.appspot.com/

Usage

$ sapin --presents --size=5 --star --garlands=4 --color

$ sapin --size=3 --balls=4 --star --emoji

$ sapin --size=1
   *
  ***
 *****
*******
   |

$ sapin --size=2
      *
     ***
    *****
   *******
    *****
   *******
  *********
 ***********
*************
     |||
     |||

$ sapin --balls=4
                   *
                  ***
                 *****
                ****@**
                 *****
                *******
               *********
              ***********
             *************
              *****@**@**
             **********@**
            ********@******
           *@***************
          ****@**@***********
         *********************
           *@************@**
          *********@*********
         ***@**********@******
        ****************@******
       @************************
      @**************************
     *****************************
       *******@*****************
      ***********@***************
     *****************************
    *************************@*****
   *******************@*************
  **********@************************
 ***********************************@*
*****************@*********************
                 |||||
                 |||||
                 |||||
                 |||||
                 |||||

$ sapin -h
Usage:
  sapin [OPTIONS]

Application Options:
  -s, --size=     Size of the sapin (5)
      --balls=    Percent of balls (4)
      --garlands= Add some garlands (4)
  -c, --color     Colorize output
      --star      Add top star
  -e, --emoji     Use emojis
      --presents  Add presents

Help Options:
  -h, --help  Show this help mess

Install

$ go get github.com/moul/sapin/cmd/sapin

Run with docker

$ docker run moul/sapin
docker run moul/sapin --size=4 --garlands=2 --star --color --presents
              #
             ***
            *****
           *****~~
            **~~~
           *~~~***
          ~~~******
         ~~*********
        *************
         ***********
        *************
       ***************
      *@***************
     ***@************@**
    *@****************@**
      @****************
     *******************
    *****@***************
   ***********************
  ********@****************
 *****************@*********
*****************************
            |||||
            |||||   _8_8_
            |||||  |  |  |_8_
            |||||  |__|__|___|

License

MIT

Documentation ¶

Examples ¶

Sapin (Complex)
Sapin (Fullballs)
Sapin (Garlands)
Sapin (Presents)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Sapin ¶

type Sapin struct {
	Size int

	ColorOpts string
	// contains filtered or unexported fields
}

Sapin is the structure defining a sapin.

Example (Complex) ¶

rand.Seed(42)
sapin := NewSapin(3)
sapin.AddBalls(4)
sapin.AddStar()
sapin.Emojize()
fmt.Println(sapin)

Output:

          💛
         🎄🎄🎄
        🎄🎄🎄🎄🎄
       🎄🎄🎄🎄🎄🎄🎄
        🎄🔴🎄🎄🎄
       🎄🎄🎄🎄🎄🔴🎄
      🎄🎄🎄🔴🎄🎄🎄🎄🎄
     🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
    🎄🎄🎄🎄🎄🎄🎄🎄🎄🔴🎄🎄🎄
     🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
    🎄🎄🎄🎄🔴🎄🔴🎄🎄🎄🎄🎄🎄
   🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🔴
  🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
 🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄🎄
         🚪🚪🚪
         🚪🚪🚪
         🚪🚪🚪

Example (Fullballs) ¶

sapin := NewSapin(3)
sapin.AddBalls(100)
fmt.Println(sapin)

Output:

          @
         @@@
        @@@@@
       @@@@@@@
        @@@@@
       @@@@@@@
      @@@@@@@@@
     @@@@@@@@@@@
    @@@@@@@@@@@@@
     @@@@@@@@@@@
    @@@@@@@@@@@@@
   @@@@@@@@@@@@@@@
  @@@@@@@@@@@@@@@@@
 @@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@
         |||
         |||
         |||

Example (Garlands) ¶

rand.Seed(41)
sapin := NewSapin(3)
sapin.AddGarlands(4)
fmt.Println(sapin)

Output:

          *
         **~
        *~~**
       ~~****~
        ***~~
       **~~***
      *~~****~~
     ~~****~~***
    ***~~~~******
     **~~~~*****
    *~~****~~****
   ~~********~~***
  *************~~**
 ****************~~*
*******************~~
         |||
         |||
         |||

Example (Presents) ¶

sapin := NewSapin(4)
sapin.AddPresents()
fmt.Println(sapin.String())

Output:

              *
             ***
            *****
           *******
            *****
           *******
          *********
         ***********
        *************
         ***********
        *************
       ***************
      *****************
     *******************
    *********************
      *****************
     *******************
    *********************
   ***********************
  *************************
 ***************************
*****************************
            |||||
            |||||   _8_8_
            |||||  |  |  |_8_
            |||||  |__|__|___|

func NewSapin ¶

func NewSapin(size int) *Sapin

NewSapin returns a Sapin instance of the specified size.

func (*Sapin) AddBalls ¶

func (s *Sapin) AddBalls(percent int)

func (*Sapin) AddGarlands ¶

func (s *Sapin) AddGarlands(quantity int)

func (*Sapin) AddPresents ¶

func (s *Sapin) AddPresents()

func (*Sapin) AddStar ¶

func (s *Sapin) AddStar()

func (*Sapin) Colorize ¶

func (s *Sapin) Colorize()

func (*Sapin) Emojize ¶

func (s *Sapin) Emojize()

func (*Sapin) GetBodySize ¶

func (s *Sapin) GetBodySize() int

func (*Sapin) GetLineSize ¶

func (s *Sapin) GetLineSize(floor, line int) int

GetLineSize returns the size of the sapin for a specified floor and line.

func (*Sapin) GetMaxSize ¶

func (s *Sapin) GetMaxSize() int

GetMaxSize returns the size of the widest part of the sapin.

func (*Sapin) String ¶

func (s *Sapin) String() string

String returns the output of a sapin drawing. If the sapin is too small the result will be empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
appspot
sapin
sapinjs

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL