calyx 0.17.0 → 0.17.1

data/docs/index.html

@@ -1,10 +1,32 @@
 ---
-layout: default
+layout: home
 ---
 
+{% include navbar.html %}
+
+<div class="spread spread-hero">
+  <figure class="identity">
+    <img src="/assets/logos/calyx-flower-2.svg" width="80%" height="80%">
+  </figure>
+  <div class="lede">
+    <h2>Create writing machines with generative grammars</h2>
+
+    <ul class="cta-list">
+      <li><a class="cta-button" href="#">Download</a></li>
+      <li><a class="cta-button" href="#">Learn more</a></li>
+    </ul>
+  </div>
+</div>
+
+<div class="spread spread-intro">
+  <p>Calyx is a simple and powerful generative grammar tool for creating writing machines using the Ruby programming language.</p>
+</div>
+
 <div class="content">
   <h1>Calyx</h1>
-  <p>Calyx provides a simple Ruby API for generating text with template expansion grammars.</p>
+  <p>Calyx provides a simple and powerful generative grammar format for creating writing machines using the Ruby programming language.</p>
+  <p>Although the primary use case is procedurally generating text, Calyx grammars can be used to make anything where the output format is a string.</p>
+  <p>Calyx provides a simple Ruby API for creating writing machines of all shapes and sizes using generative grammars.</p>
   <ul>
     <li><a href="https://github.com/maetl/calyx">Source code on GitHub</a></li>
     <li><a href="https://rubygems.org/gems/calyx">Package on Rubygems</a></li>

data/docs/package-lock.json

@@ -1292,6 +1292,15 @@
         "readable-stream": "2.3.3"
       }
     },
+    "string_decoder": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
+      "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
+      "dev": true,
+      "requires": {
+        "safe-buffer": "5.1.1"
+      }
+    },
     "string-width": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz",
@@ -1303,15 +1312,6 @@
         "strip-ansi": "3.0.1"
       }
     },
-    "string_decoder": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
-      "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
-      "dev": true,
-      "requires": {
-        "safe-buffer": "5.1.1"
-      }
-    },
     "stringstream": {
       "version": "0.0.5",
       "resolved": "https://registry.npmjs.org/stringstream/-/stringstream-0.0.5.tgz",

data/docs/package.json

@@ -4,6 +4,7 @@
   "main": "index.html",
   "scripts": {
     "build": "node-sass --include-path node_modules/bulma calyx-docs.scss assets/calyx-docs.css",
+    "watch": "node-sass --watch --include-path node_modules/bulma docs.scss assets/calyx-docs.css",
     "help": "node-sass --help"
   },
   "author": "Mark Rickerby <me@maetl.net>",

data/lib/calyx/grammar.rb

@@ -47,7 +47,8 @@ module Calyx
       # DSL helper method for registering the given block as a string filter.
       #
       # @param [Symbol] name
-      # @block block with a single string argument returning a modified string.
+      # @yieldparam [String] the input string to be processed by the filter
+      # @yieldreturn [String] the processed output string
       def filter(name, &block)
         registry.filter(name, &block)
       end
@@ -99,24 +100,24 @@ module Calyx
     # evaluated.
     #
     # @param [Numeric, Random, Hash] options
-    def initialize(opts={}, &block)
-      unless opts.is_a?(Hash)
+    def initialize(options={}, &block)
+      unless options.is_a?(Hash)
         config_opts = {}
-        if opts.is_a?(Numeric)
+        if options.is_a?(Numeric)
           warn [
             "NOTE: Passing a numeric seed arg directly is deprecated. ",
             "Use the options hash instead: `Calyx::Grammar.new(seed: 1234)`"
           ].join
-          config_opts[:seed] = opts
-        elsif opts.is_a?(Random)
+          config_opts[:seed] = options
+        elsif options.is_a?(Random)
           warn [
             "NOTE: Passing a Random object directly is deprecated. ",
             "Use the options hash instead: `Calyx::Grammar.new(rng: Random.new)`"
           ].join
-          config_opts[:rng] = opts
+          config_opts[:rng] = options
         end
       else
-        config_opts = opts
+        config_opts = options
       end
 
       @options = Options.new(config_opts)
@@ -133,7 +134,11 @@ module Calyx
 
     # Produces a string as an output of the grammar.
     #
-    # @overload
+    # @overload generate(start_symbol)
+    #   @param [Symbol] start_symbol
+    # @overload generate(rules_map)
+    #   @param [Hash] rules_map
+    # @overload generate(start_symbol, rules_map)
     #   @param [Symbol] start_symbol
     #   @param [Hash] rules_map
     # @return [String]
@@ -159,7 +164,11 @@ module Calyx
     # Produces a generated result from evaluating the grammar.
     #
     # @see Calyx::Result
-    # @overload
+    # @overload generate_result(start_symbol)
+    #   @param [Symbol] start_symbol
+    # @overload generate_result(rules_map)
+    #   @param [Hash] rules_map
+    # @overload generate_result(start_symbol, rules_map)
     #   @param [Symbol] start_symbol
     #   @param [Hash] rules_map
     # @return [Calyx::Result]

data/lib/calyx/options.rb

@@ -10,7 +10,7 @@ module Calyx
     # Constructs a new options instance, merging the passed in options with the
     # defaults.
     #
-    # @params [Hash, Calyx::Options] options
+    # @param [Hash, Calyx::Options] options
     def initialize(options={})
       @options = DEFAULTS.merge(options)
     end
@@ -54,7 +54,7 @@ module Calyx
 
     # Merges two instances together and returns a new instance.
     #
-    # @params [Calyx::Options]
+    # @param [Calyx::Options] options
     # @return [Calyx::Options]
     def merge(options)
       Options.new(@options.merge(options.to_h))

data/lib/calyx/registry.rb

@@ -20,7 +20,7 @@ module Calyx
 
     # Attaches a modifier module to this instance.
     #
-    # @param [Module] module_name
+    # @param [Module] name
     def modifier(name)
       modifiers.extend(name)
     end
@@ -36,7 +36,8 @@ module Calyx
     # Registers the given block as a string filter.
     #
     # @param [Symbol] name
-    # @block block with a single string argument returning a modified string.
+    # @yield [String]
+    # @yieldreturn [String]
     def filter(name, callable=nil, &block)
       if block_given?
         transforms[name.to_sym] = block
@@ -154,7 +155,6 @@ module Calyx
     # Produces a syntax tree of nested list nodes.
     #
     # @param [Symbol] start_symbol
-    # @param [Random] random
     # @param [Hash] rules_map
     # @return [Array]
     def evaluate(start_symbol=:start, rules_map={})

data/lib/calyx/result.rb

@@ -5,8 +5,9 @@ module Calyx
       @expression = expression.freeze
     end
 
-    # The syntax tree of nested nodes representing the production rules which
-    # generated this result.
+    # Produces a syntax tree of nested nodes as the output of the grammar. Each
+    # syntax node represents the production rules that were evaluated at each
+    # step of the generator.
     #
     # @return [Array]
     def tree
@@ -15,7 +16,7 @@ module Calyx
 
     alias_method :to_exp, :tree
 
-    # The generated text string produced by the grammar.
+    # Produces a text string as the output of the grammar.
     #
     # @return [String]
     def text
@@ -26,7 +27,7 @@ module Calyx
 
     alias_method :to_s, :text
 
-    # A symbol produced by converting the generated text string where possible.
+    # Produces a symbol as the output of the grammar.
     #
     # @return [Symbol]
     def symbol

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.17.0'.freeze
+  VERSION = '0.17.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -76,6 +77,14 @@ files:
 - docs/about.md
 - docs/assets/calyx-docs.css
 - docs/calyx-docs.scss
+- docs/guide/context.md
+- docs/guide/examples.md
+- docs/guide/expressions.md
+- docs/guide/formats.md
+- docs/guide/getting-started.md
+- docs/guide/installation.md
+- docs/guide/random.md
+- docs/guide/results.md
 - docs/index.html
 - docs/package-lock.json
 - docs/package.json
@@ -126,4 +135,3 @@ signing_key:
 specification_version: 4
 summary: Generate text with declarative recursive grammars
 test_files: []
-has_rdoc: