wordz 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d05083af32ff497031e91e20de1606526e492e1787a77427fd38a0e635d8459
-  data.tar.gz: 7bac7ddae0032a039cf47b71105c7f2b2715a530b5b791bfb5389de9f5b0aacb
+  metadata.gz: ec2263a33b331dbee70fbfa5735b144f373e9e5f4ff51fda803779f5131d5dbe
+  data.tar.gz: dfd3a764d11b2df3e6d8fc4d2c91fd9b3290d55033c7b46dd70a0655bd8923cd
 SHA512:
-  metadata.gz: eee6ff9c0859037276b4d59e3278cf426fd71729925d5f79244010671a9fd91ce6fbeb8db3393491757fd7f62071f95c4747a1bc4795e96c0878cb477eac12da
-  data.tar.gz: 2ca72d0759b30bbcd92b51a23b8041840a52f99d476e0b5fc435392e1d0e272e670d1c4a145dec5f22ff7211df36465569b712d3f210b013ca982feb06e5893a
+  metadata.gz: 6597a9cab7daf0c95f80fd9dd646a7c3ccfea124c8d9b62ceef3d20fb5a7ac3694b83e0a29dd32aca2168b891bbb806ce7ded9ce380f6821b50a1bfd4a977313
+  data.tar.gz: df517cb56e8ebea912ce8a1f21be556045d82c057a8ae2d1ede6c2716e0c348f75f30a638ba4d066a62b978bee116585be314b3e3013423d8c34db7707524e13

data/README.md

@@ -5,3 +5,32 @@
 # Wordz
 
 A minimalist generative grammar library. For use in bots and other mischief.
+
+# Usage
+
+```ruby
+grammar = {
+  "<root>" => [
+    ["#dog#name#", "says", "<bark>", "."],
+  ],
+  "<bark>" => [
+    ["ruff"],
+    ["woof"],
+  ]
+}
+
+class Dog
+  def name
+    "Daisy"
+  end
+end
+
+Wordz.generate(
+  grammar: grammar,
+  subjects: { dog: Dog.new },
+)
+
+# Will return one of the following, at random.
+# => "Daisy says ruff."
+# => "Daisy says arf." 
+```

data/Rakefile

@@ -4,3 +4,11 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+namespace :irb do
+  desc "Open interactive REPL with our application preloaded"
+
+  task :console do
+    system("irb -r ./lib/wordz.rb")
+  end
+end

data/lib/wordz.rb

@@ -4,6 +4,9 @@ WORDZ_APP_PATH = File.expand_path("../", __FILE__) + "/wordz"
 
 module Wordz
   autoload(:PostProcessor, "#{WORDZ_APP_PATH}/post_processor.rb")
+  autoload(:Client, "#{WORDZ_APP_PATH}/client.rb")
+
+  extend Wordz::Client
 end
 
 Dir["#{WORDZ_APP_PATH}/**/*.rb"].each { |file| require file }

data/lib/wordz/client.rb

@@ -0,0 +1,10 @@
+module Wordz
+  module Client
+    def generate(grammar: {}, subjects: {}, root: nil)
+      Generator.new(
+        grammar: grammar,
+        subjects: subjects,
+      ).call(root)
+    end
+  end
+end

data/lib/wordz/generator.rb

@@ -8,13 +8,14 @@ module Wordz
 
     ROOT_NODE = "<root>".freeze
 
-    def initialize(grammar = {}, subjects: {})
+    def initialize(grammar: {}, subjects: {})
       @output = []
       @subjects = subjects
       @grammar = grammar
     end
 
-    def generate(root_node = ROOT_NODE)
+    def call(root_node = nil)
+      root_node ||= ROOT_NODE
       post_process(generate_list(root_node))
     end
 

data/lib/wordz/version.rb

@@ -1,3 +1,3 @@
 module Wordz
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wordz
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2017-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - bin/console
 - bin/setup
 - lib/wordz.rb
+- lib/wordz/client.rb
 - lib/wordz/generator.rb
 - lib/wordz/instruction.rb
 - lib/wordz/post_processor.rb