calyx 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719581f0b1a1255f386ed91d64b2d956b1e7820c
-  data.tar.gz: 173aaada6063be3dad4c1eaa707390608a5b952e
+  metadata.gz: 833328ded64a82edb7997b924f740a458d179215
+  data.tar.gz: bfca7e43959b79427ecfed6116344bd82aa79e95
 SHA512:
-  metadata.gz: c1510e5ba1db72a661965766c78cb5e6a79e04be682997c2e1f4ddf5c85623c9eb5785bc273a492feed090704e84cc78dc791a4ccdbadec9ac2e436b1849009a
-  data.tar.gz: b835c0ddee655a64bdad32f8487aa1563812a355c916713e8e9476a0a021f0cf689639a0a986591e3777a8b81a40ca55173140f3bc3e800f04516cc7b4ad6c0b
+  metadata.gz: 79b97a8dbb5ded857a14f61f687ff2e93ba6c65f75b2f9acbab74c5b34803d2bfd6f5c2b26eeda52640037ba60d56926d849dd0de2d7a1db84ecde9ffbe37c0c
+  data.tar.gz: 7f846571bdefe5c2e922e00218d7f64b79c343344cce9e0395dfe1f7ced7d8cf79ddd71c9be1d061d95d07de09c35ae8ce73954fbcdda000433b358eac6bec15

data/README.md

@@ -1,3 +1,97 @@
 # Calyx
 
 Calyx provides a simple API for generating text with declarative recursive grammars.
+
+## Install
+
+### Command Line
+
+```
+gem install calyx
+```
+
+## Gemfile
+
+```
+gem 'calyx'
+```
+
+## Usage
+
+Require the library and inherit from `Calyx::Grammar` to construct a set of rules to generate a text. All grammars require a `start` rule, which specifies the starting point for generating the text structure.
+
+```ruby
+require 'calyx'
+
+class HelloWorld < Calyx::Grammar
+  start 'Hello world.'
+end
+```
+
+To generate the text itself, initialize the object and call the `generate` method.
+
+```ruby
+hello = HelloWorld.new
+hello.generate
+# > "Hello world."
+```
+
+Obviously, this hardcoded sentence isn’t very interesting by itself. Possible variations can be added to the text using the `rule` constructor to provide a named set of text strings and the rule delimiter syntax (`{}`) within the text strings to substitute the generated content of the rule.
+
+```ruby
+class HelloWorld < Calyx::Grammar
+  start '{greeting} world.'
+  rule :greeting, 'Hello', 'Hi', 'Hey', 'Yo'
+end
+
+hello = HelloWorld.new
+
+hello.generate
+# > "Hi world."
+
+hello.generate
+# > "Hello world."
+
+hello.generate
+# > "Yo world."
+```
+
+Rules are recursive. They can be arbitrarily nested and connected to generate larger and more complex texts.
+
+```ruby
+class HelloWorld < Calyx::Grammar
+  start '{greeting} {world_phrase}.'
+  rule :greeting, 'Hello', 'Hi', 'Hey', 'Yo'
+  rule :world_phrase, '{happy_adj} world', '{sad_adj} world', 'world'
+  rule :happy_adj, 'wonderful', 'amazing', 'bright', 'beautiful'
+  rule :sad_adj, 'cruel', 'miserable'
+end
+```
+
+Nesting and hierarchy can be manipulated to balance consistency with variation. The exact same word atoms can be combined in different ways to produce strikingly different resulting texts.
+
+```ruby
+module HelloWorld
+  Sentiment < Calyx::Grammar
+    start '{happy_phrase}', '{sad_phrase}'
+    rule :happy_phrase, '{happy_greeting} {happy_adj} world.'
+    rule :happy_greeting, 'Hello', 'Hi', 'Hey', 'Yo'
+    rule :happy_adj, 'wonderful', 'amazing', 'bright', 'beautiful'
+    rule :sad_phrase, '{sad_greeting} {sad_adj} world.'
+    rule :sad_greeting, 'Goodbye', 'So long', 'Farewell'
+    rule :sad_adj, 'cruel', 'miserable'
+  end
+
+  Mixed < Calyx::Grammar
+    start '{greeting} {adj} world.'
+    rule :greeting, 'Hello', 'Hi', 'Hey', 'Yo', 'Goodbye', 'So long', 'Farewell'
+    rule :adj, 'wonderful', 'amazing', 'bright', 'beautiful', 'cruel', 'miserable'
+  end
+end
+```
+
+## License
+
+Calyx is open source and provided under the terms of the MIT license. Copyright (c) 2015 Mark Rickerby
+
+See the `LICENSE` file [included with the project distribution](https://github.com/maetl/calyx/blob/master/LICENSE) for more information.

data/lib/calyx.rb

@@ -104,7 +104,10 @@ module Calyx
         end
 
         def evaluate(registry)
-          choice = @collection.max_by { |_, weight| rand ** (1.0 / weight) }.first
+          choice = @collection.max_by do |_, weight|
+            rand ** (1.0 / weight)
+          end.first
+
           choice.evaluate(registry)
         end
       end

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler