colorly 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 203252a3e4c17ec95aa97615d18480e6ba3491abb3b6d7723525940dc30e19a2
-  data.tar.gz: 24b8f4b7dab4cbcc5e2a2fbfb7af9037649219f732eb54b7de1957b61f40b435
+  metadata.gz: e7535f4f4f8e3bfddf9fd52b898c9d9462cadff128268a6be84d8f36dc701f58
+  data.tar.gz: 58066978fcee8cbfaac56e8f4be3e11550756083e3e490af10e29245d19a82f5
 SHA512:
-  metadata.gz: 0ec3960059f744883ef5897a5767f09797355f360c3662077ffc06d7324e89e36f61b1a60252ff83859978f8ace16643ecd6b1f69b1649b6bcc1cbafdbed91a2
-  data.tar.gz: 04c24635d279d4ca9ce689d3e8c993bc8272a3e3dfd1021e066befced21c60a24cd98cde556f9514d1ac009efbfd4de3049c9d10b49139f8fab25e849409b785
+  metadata.gz: a66ca24e08128a4922e3b0249b4b577fb9cebc6ecbe1fe65a4d877e05d18a67d3499309c819a0c0d67f24afef4640c6b8ec5e0e5a79bc92185907bbc1ce05132
+  data.tar.gz: 702180db6d13a1a8da042257c06f51983791234d4113591552cc8e33def5c007ad2ff1cd0d2c3f2fbfa4126c9c3d8fdd62c9ba855e8cf44bb49c90045d77fa42

data/README.md

@@ -2,10 +2,11 @@
 
 [![Gem Version](https://badge.fury.io/rb/colorly.svg)](https://badge.fury.io/rb/colorly)
 [![Build Status](https://github.com/DannyBen/colorly/workflows/Test/badge.svg)](https://github.com/DannyBen/colorly/actions?query=workflow%3ATest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a708b1651a6caf451d53/maintainability)](https://codeclimate.com/github/DannyBen/colorly/maintainability)
 
 ---
 
-Colorly is a command line urility and a Ruby library for generating color
+Colorly is a command line utility and a Ruby library for generating color
 palettes using a simple DSL.
 
 It is a thin wrapper around the [chroma] gem.
@@ -20,11 +21,136 @@ The colorly command line outputs the palette as JSON, YAML or HTML.
 $ gem install colorly
 ```
 
+## Example
+
+Colorly provides you with a simple ruby-based DSL for generating a color palette.
+
+Start by creating this file:
+
+```ruby
+# sample.rb
+title "Set 1"
+add 'red'.lighten 20
+add last.spin 60
+add last.spin 60
+```
+
+then run it by calling:
+
+```
+$ colorly sample.rb output.html
+```
+
+output:
+
+![](assets/readme-sample-1.png)
+
+For more detailed examples, view the [examples folder](examples).
+
+
+## Usage 
+
+Colorly scripts are built with a minimalist set of Ruby commands (DSL):
+
+```ruby
+# Start a new color set
+title "Any unique name for this set"
+
+# Add colors to this set
+add 'yellow'.darken(10).desaturate(10)
+add last.spin 20
+
+# Start another set
+title "New set"
+add '#ff3344'
+# ...
+```
+
+The colors provided to the `add` command can be
+[anything that is supported by `Chroma`](https://github.com/jfairbank/chroma#creating-colors),
+or an array of the same.
+
+In addition, you can call the below `Chroma` methods directly on any color.
+They will be forwarded to `Chroma`:
+
+```ruby
+'red'.spin        # same as 'red'.paint.spin
+'red'.brighten    # same as 'red'.paint.brighten
+'red'.darken      # same as 'red'.paint.darken 
+'red'.lighten     # same as 'red'.paint.lighten 
+'red'.saturate    # same as 'red'.paint.saturate 
+'red'.desaturate  # same as 'red'.paint.desaturate 
+'red'.greyscale   # same as 'red'.paint.greyscale (also grayscale)
+'red'.palette     # same as 'red'.paint.palette
+```
+
+You can use the last added color with the variable `last`, and generate a
+random color by calling `random`:
+
+```ruby
+title "Example"
+add 'red'.spin 10
+add last.spin 30
+add last.spin 30
+add random.desaturate 10
+```
+
+## Using from Ruby code
+
+If you wish to use Colorly from your own Ruby code, simply load a script to 
+the Script class:
+
+```ruby
+require 'colorly'
+
+# Load from a file
+script = Colorly::Script.load 'script_file.rb'
+
+# ... or from a string
+script_string = "title 'Hello'; add params[:base_color] ; add last.spin 90"
+script = Colorly::Script.new script_string
+
+# Optionally, pass parameters to the script, which you can use in the script
+# by accessing the `params` hash.
+script.params = { base_color: '#cdc' }
+# or
+script.params[:base_color] = '#cdc'
+
+# Run it
+script.run
+
+# Get its output - each color is a Chroma::Color object
+p script.output
+p script.output["Hello"].first.class
+#=> {"Hello"=>[#ff2b00, #ff5500]}
+#=> Chroma::Color
+
+# Get a simplified output where each color is just its hex string
+p script.simple_output
+#=> {"Hello"=>["#ff2b00", "#ff5500"]}
+
+# Get a simplified output, including color names (slower)
+# Get a simplified output, including color names (slower)
+pp script.simple_output names: true
+#=> {"Hello"=>
+#=>   [{:hex=>"#ff2b00", :name=>["Scarlet", "Red"]},
+#=>    {:hex=>"#ff5500", :name=>["International Orange", "Orange"]}]}
+```
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+## Credits
+
+- [Jeremy Fairbank](https://github.com/jfairbank) for the [chroma] gem.
+- [Chirag Mehta](https://chir.ag/) for the original Javascript [color naming functions](https://chir.ag/projects/name-that-color).
+- [Colblindor](https://www.color-blindness.com/color-name-hue/) for the additional base color (shade) work.
 
-## Usage
 
-SOON
 
 ---
 
 [chroma]: https://github.com/jfairbank/chroma
+[issues]: https://github.com/DannyBen/colorly/issues

data/lib/colorly/command.rb

@@ -10,28 +10,33 @@ module Colorly
   class Command < MisterBin::Command
     include Colsole
     summary "Run a colorly script"
+    version Colorly::VERSION
 
     help "Execute a colorly script and save or print its output"
 
-    usage "colorly SCRIPT [OUTPUT_PATH] [--watch]"
-    usage "colorly --help"
+    usage "colorly SCRIPT [OUTPUT_PATH] [--watch --names]"
+    usage "colorly --help | --version"
 
-    option "-w, --watch", "Watch the script file and regenerate on change"
+    option "-w --watch", "Watch the script file and regenerate on change"
+    option "-n --names", "Also show color names and shades (slower)"
 
     param "SCRIPT", "Path to script file"
     param "OUTPUT_PATH", "Path to output file. The output format is determined by the file extension. Supported formats:\n- YAML (.yaml or .yml)\n- JSON (.json)\n- HTML (.html)\nIf left empty, YAML format will be sent to STDOUT."
 
-    example "colorly examples/sample.rb"
-    example "colorly examples/sample.rb out.json"
-    example "colorly examples/sample.rb out.html --watch"
+    example "colorly examples/example.rb"
+    example "colorly examples/example.rb --names"
+    example "colorly examples/example.rb out.json"
+    example "colorly examples/example.rb out.html --watch --names"
 
-    attr_reader :script_path, :script, :out_path
+    attr_reader :script_path, :script, :out_path, :use_names
 
     def run
       @script_path = args['SCRIPT']
       @out_path = args['OUTPUT_PATH']
+      @use_names = args['--names']
 
       if args['--watch']
+        generate
         watch_and_generate
       else
         generate
@@ -55,17 +60,21 @@ module Colorly
     end
 
     def show_output
-      puts script.to_h.to_yaml
+      puts simple_output.to_yaml
+    end
+
+    def simple_output
+      script.simple_output names: use_names
     end
 
     def save_file
       out_string = case out_path
       when /\.json$/
-        JSON.pretty_generate script.to_h
+        JSON.pretty_generate simple_output
       when /\.ya?ml$/
-        script.to_h.to_yaml
+        simple_output.to_yaml
       when /\.html$/
-        erb html_template, { output: script.output }
+        erb html_template, { output: script.output, use_names: use_names }
       else
         raise Colorly::ArgumentError, "Unknown output format for #{out_path}"
       end
@@ -83,8 +92,7 @@ module Colorly
     end
 
     def erb(template, vars)
-      ERB.new(template).result(OpenStruct.new(vars).instance_eval { binding })
+      ERB.new(template, trim_mode: '%-').result(OpenStruct.new(vars).instance_eval { binding })
     end
-
   end
 end