calyx 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e2075bb19864a35f97504f1d2afc2e09b186ab
-  data.tar.gz: 1e474a6d3bac3d62d5a8b25c5ad75ec724a95a44
+  metadata.gz: 3a89c9fc6b0ecc0e8779331da13072f11d810eab
+  data.tar.gz: 8a74d06ae8feb2e547426fbf893a3d2922010f29
 SHA512:
-  metadata.gz: 8d4facec94b4ffd5c29bfb53d4f8cd6b0de4939d9937ed0853a15420246deeee0fb543ae210e6462b4b707f1c82bd9c462b54b427a8637bf35b7536bb3a4b842
-  data.tar.gz: fd89979f568bd4ec3bd3655dfcacddf405841766ed7bef6a32a8d2d7a0ce501aa3bbc4fa85e67a0455106701f50787c071afbd6f4a6eb02d091f46c9a67a2be7
+  metadata.gz: c178d2441191f82aa308ae5d8599bb904a68128daa636435830b6ec58443cfa3ea1dd9a8e534b206442d658542f4aae8a5d906b9cd0677e22db7e983116529f9
+  data.tar.gz: 8ba8bb5db4ed05e66d9c1fb19986282607d6cbd10fac4de6ed70a18be5ae08b39367fd3931fd8c485b6bfc7687aae7610817547a6668b6de94a078fb843b240e

data/README.md

@@ -181,6 +181,8 @@ class Fruit < Calyx::Grammar
 end
 ```
 
+## String Modifiers
+
 Dot-notation is supported in template expressions, allowing you to call any available method on the `String` object returned from a rule. Formatting methods can be chained arbitrarily and will execute in the same way as they would in native Ruby code.
 
 ```ruby
@@ -193,7 +195,77 @@ end
 # => "Why, hello there."
 ```
 
-In order to use more intricate natural language processing capabilities, you can embed additional methods onto the `String` class yourself, as well as use methods from existing Gems that monkeypatch `String`.
+You can also extend the grammar with custom modifiers that provide useful formatting functions.
+
+### Filters
+
+Filters accept an input string and return the transformed output:
+
+```ruby
+class Greeting < Calyx::Grammar
+  filter :shoutycaps do |input|
+    input.upcase
+  end
+  start '{hello.shoutycaps} there.', 'Why, {hello} there.'
+  rule :hello, 'hello'
+end
+
+# => "HELLO there."
+# => "Why, HELLO there."
+```
+
+### Mappings
+
+The mapping shortcut allows you to specify a map of regex patterns pointing to their resulting substitution strings:
+
+```ruby
+class GreenBottle < Calyx::Grammar
+  mapping :pluralize, /(.+)/ => '\\1s'
+  start 'One green {bottle}.', 'Two green {bottle.pluralize}.'
+  rule :bottle, 'bottle'
+end
+
+# => "One green bottle."
+# => "Two green bottles."
+```
+
+### Modifier Mixins
+
+In order to use more intricate natural language processing capabilities, you can add modifier methods to a module and extend the grammar with it:
+
+```ruby
+module FullStop
+  def full_stop
+    self << '.'
+  end
+end
+
+class Hello < Calyx::Grammar
+  modifier FullStop
+  start '{hello.capitalize.full_stop}'
+  rule :hello, 'hello'
+end
+
+# => "Hello."
+```
+
+To share custom modifiers across multiple grammars, you can include the module in `Calyx::Modifiers`. This will make the methods available to all subsequent instances:
+
+```ruby
+module FullStop
+  def full_stop
+    self << '.'
+  end
+end
+
+class Calyx::Modifiers
+  include FullStop
+end
+```
+
+### Monkeypatching String
+
+Alternatively, you can combine methods from existing Gems that monkeypatch `String`:
 
 ```ruby
 require 'indefinite_article'
@@ -305,7 +377,12 @@ Rough plan for stabilising the API and features for a `1.0` release.
 
 ## Credits
 
-- [Mark Rickerby](https://github.com/maetl) (author and maintainer)
+### Author & Maintainer
+
+- [Mark Rickerby](https://github.com/maetl)
+
+### Contributors
+
 - [Tariq Ali](https://github.com/tra38)
 
 ## License

data/lib/calyx.rb

@@ -1,9 +1,9 @@
 require 'calyx/version'
 require 'calyx/grammar'
 require 'calyx/errors'
-require 'calyx/file_converter'
+require 'calyx/format'
 require 'calyx/registry'
-require 'calyx/modifier'
+require 'calyx/modifiers'
 require 'calyx/production/memo'
 require 'calyx/production/choices'
 require 'calyx/production/concat'

data/lib/calyx/errors.rb

@@ -1,3 +1,11 @@
 module Calyx
-  class RuleNotFound < NoMethodError; end
+  module Errors
+    class RuleNotFound < StandardError; end
+
+    class DuplicateRule < StandardError
+      def initialize(key)
+        super("Rule already declared in grammar: #{key}")
+      end
+    end
+  end
 end

data/lib/calyx/format.rb

@@ -0,0 +1,37 @@
+module Calyx
+  module Format
+    def self.load(filename)
+      file = File.read(filename)
+      extension = File.extname(filename)
+      if extension == ".yml"
+        self.load_yml(file)
+      elsif extension == ".json"
+        self.load_json(file)
+      else
+        raise "Cannot convert #{extension} files."
+      end
+    end
+
+    def self.load_yml(file)
+      require 'yaml'
+      yaml = YAML.load(file)
+      self.build_grammar(yaml)
+    end
+
+    def self.load_json(file)
+      require 'json'
+      json = JSON.parse(file)
+      self.build_grammar(json)
+    end
+
+    private
+
+    def self.build_grammar(rules)
+      Calyx::Grammar.new do
+        rules.each do |label, productions|
+          rule(label, *productions)
+        end
+      end
+    end
+  end
+end

data/lib/calyx/grammar.rb

@@ -5,6 +5,10 @@ module Calyx
         @registry ||= Registry.new
       end
 
+      def load(filename)
+        Format.load(filename)
+      end
+
       def modifier(name)
         registry.modifier(name)
       end

data/lib/calyx/{modifier.rb → modifiers.rb}

@@ -1,5 +1,5 @@
 module Calyx
-  class Modifier
+  class Modifiers
     def extend_with(name)
       extend name
     end

data/lib/calyx/registry.rb

@@ -1,11 +1,11 @@
 module Calyx
   class Registry
-    attr_reader :rules, :transforms
+    attr_reader :rules, :transforms, :modifiers
 
     def initialize
       @rules = {}
       @transforms = {}
-      @modifier = Modifier.new
+      @modifiers = Modifiers.new
     end
 
     def method_missing(name, *arguments)
@@ -13,7 +13,7 @@ module Calyx
     end
 
     def modifier(name)
-      @modifier.extend_with(name)
+      modifiers.extend_with(name)
     end
 
     def mapping(name, pairs)
@@ -40,7 +40,7 @@ module Calyx
       if transforms.key?(name)
         transforms[name].call(value)
       else
-        @modifier.transform(name, value)
+        modifiers.transform(name, value)
       end
     end
 
@@ -57,7 +57,7 @@ module Calyx
 
       rules_map.each do |key, value|
         if rules.key?(key.to_sym)
-          raise "Rule already declared in grammar: #{key}"
+          raise Error::DuplicateRule.new(key)
         end
 
         context[key.to_sym] = if value.is_a?(Array)
@@ -72,7 +72,7 @@ module Calyx
       if expansion.respond_to?(:evaluate)
         [start_symbol, expansion.evaluate]
       else
-        raise RuleNotFound.new(start_symbol)
+        raise Errors::RuleNotFound.new(start_symbol)
       end
     end
 
@@ -93,7 +93,9 @@ module Calyx
     end
 
     def construct_rule(productions)
-      if productions.first.is_a?(Enumerable)
+      if productions.first.is_a?(Hash)
+        Production::WeightedChoices.parse(productions.first.to_a, self)
+      elsif productions.first.is_a?(Enumerable)
         Production::WeightedChoices.parse(productions, self)
       else
         Production::Choices.parse(productions, self)

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.10.4'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,9 +69,9 @@ files:
 - examples/tiny_woodland.rb
 - lib/calyx.rb
 - lib/calyx/errors.rb
-- lib/calyx/file_converter.rb
+- lib/calyx/format.rb
 - lib/calyx/grammar.rb
-- lib/calyx/modifier.rb
+- lib/calyx/modifiers.rb
 - lib/calyx/production/choices.rb
 - lib/calyx/production/concat.rb
 - lib/calyx/production/expression.rb

data/lib/calyx/file_converter.rb

@@ -1,40 +0,0 @@
-require 'yaml'
-require 'json'
-
-module Calyx
-  class Grammar
-    class << self
-      def load(filename)
-        file = File.read(filename)
-        extension = File.extname(filename)
-        if extension == ".yml"
-          load_yml(file)
-        elsif extension == ".json"
-          load_json(file)
-        else
-          raise "Cannot convert #{extension} files."
-        end
-      end
-
-      def load_yml(file)
-        yaml = YAML.load(file)
-        build_grammar(yaml)
-      end
-
-      def load_json(file)
-        json = JSON.parse(file)
-        build_grammar(json)
-      end
-
-      private
-
-      def build_grammar(rules)
-        Calyx::Grammar.new do
-          rules.each do |label, productions|
-            rule(label, *productions)
-          end
-        end
-      end
-    end
-  end
-end