calyx 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbece8aa49b259e11dfd37c03f3ea13050349f30c003bf8f9874bb069e3b4866
-  data.tar.gz: fe7e4b4df68c0daf35688b5c103b85302ae953d98d0e326f9e087d5d1d7fdf9c
+  metadata.gz: 88debcd6bac2845d1d5b6c932aff212a3d93a900cfb6758db486500f49987e7e
+  data.tar.gz: 7a22972ac485e7147f0855bac351badaa25876978655191e75327a54a404cd4d
 SHA512:
-  metadata.gz: 7237633f9354a5e81b05b8840b514ab2060b45d936b496e2cb47abdefce019c6d14a7350f416f1137866e73d84f5a1e169cbda78c879aa49d0c83543c0cd3f06
-  data.tar.gz: babf2c39c0550cbdccc8e5a2822ae8030f827e96f424a17e9ffdd22a13d22504610400b19425b3dde9dd4a9932285253d03f3d52a23c20751791e4139601bc7d
+  metadata.gz: 716f85a44ca0e852c96695ffdd6ddb91b298c5c6579a61d5082893be445ab78d6e8b7b37ac0f50eac2169f14ada86c0001cabf7c354ae4ba6ecd763c0335de8e
+  data.tar.gz: 63de5c1d2d1ccaa74232eb3c7535df24cdce5fc2065bedc2cf90a8a590080397d9e1881cbee15501aeb8ef61f206b561e5e2888f0c7dee22680eefbb83c1e615

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.travis.yml

@@ -5,6 +5,6 @@ rvm:
   - 2.6
   - ruby-head
   - jruby-9.1.13.0
-  - rbx-3
+  - rbx
 before_install: gem install bundler
 script: bundle exec rspec

data/lib/calyx.rb

@@ -8,6 +8,7 @@ require 'calyx/errors'
 require 'calyx/format'
 require 'calyx/registry'
 require 'calyx/modifiers'
+require 'calyx/mapping'
 require 'calyx/production/memo'
 require 'calyx/production/unique'
 require 'calyx/production/choices'

data/lib/calyx/grammar.rb

@@ -33,6 +33,10 @@ module Calyx
       #
       # @param [Module] module_name
       def modifier(module_name)
+        warn [
+          "NOTE: Loading modifiers via grammar class methods is deprecated.",
+          "Alternative API TBD. For now this method still works."
+        ].join
         registry.modifier(module_name)
       end
 
@@ -41,6 +45,10 @@ module Calyx
       # @param [Symbol] name
       # @param [Hash<Regex,String>] pairs
       def mapping(name, pairs)
+        warn [
+          "NOTE: The fixed `mapping` class method is deprecated.",
+          "This still works but will be replaced with a new mapping format."
+        ].join
         registry.mapping(name, pairs)
       end
 
@@ -50,6 +58,10 @@ module Calyx
       # @yieldparam [String] the input string to be processed by the filter
       # @yieldreturn [String] the processed output string
       def filter(name, &block)
+        warn [
+          "NOTE: The fixed `filter` class method is deprecated.",
+          "This will be removed in 0.22. Use the API for modifers instead."
+        ].join
         registry.filter(name, &block)
       end
 

data/lib/calyx/mapping.rb

@@ -0,0 +1,15 @@
+module Calyx
+  class Mapping
+    def initialize
+      @key = "key"
+      @value = "value"
+    end
+
+    def call(input)
+      if @key == input then @value
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/calyx/modifiers.rb

@@ -20,5 +20,15 @@ module Calyx
         value
       end
     end
+
+    def upper(value)
+      value.upcase
+    end
+
+    def lower(value)
+      value.downcase
+    end
+
+
   end
 end

data/lib/calyx/production/weighted_choices.rb

@@ -63,6 +63,13 @@ module Calyx
         @collection = collection
       end
 
+      # The number of possible choices available for this rule.
+      #
+      # @return [Integer]
+      def size
+        @collection.size
+      end
+
       # Evaluate the choice by randomly picking one of its possible options,
       # balanced according to the given weights.
       #

data/lib/calyx/registry.rb

@@ -67,7 +67,7 @@ module Calyx
     # @param [Symbol] name
     # @param [Array] productions
     def define_rule(name, trace, productions)
-      rules[name.to_sym] = Rule.new(name.to_sym, construct_rule(productions), trace)
+      rules[name.to_sym] = Rule.new(name.to_sym, Rule.build_ast(productions, self), trace)
     end
 
     # Defines a rule in the temporary evaluation context.
@@ -76,7 +76,7 @@ module Calyx
     # @param [Array] productions
     def define_context_rule(name, trace, productions)
       productions = [productions] unless productions.is_a?(Enumerable)
-      context[name.to_sym] = Rule.new(name.to_sym, construct_rule(productions), trace)
+      context[name.to_sym] = Rule.new(name.to_sym, Rule.build_ast(productions, self), trace)
     end
 
     # Expands the given symbol to its rule.
@@ -197,15 +197,5 @@ module Calyx
         end
       }
     end
-
-    def construct_rule(productions)
-      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)
-      end
-    end
   end
 end

data/lib/calyx/rule.rb

@@ -2,20 +2,30 @@ module Calyx
   # Represents a named rule connected to a tree of productions that can be
   # evaluated and a trace which represents where the rule was declared.
   class Rule
-    attr_reader :name, :productions, :trace
+    def self.build_ast(productions, registry)
+      if productions.first.is_a?(Hash)
+        Production::WeightedChoices.parse(productions.first.to_a, registry)
+      elsif productions.first.is_a?(Enumerable)
+        Production::WeightedChoices.parse(productions, registry)
+      else
+        Production::Choices.parse(productions, registry)
+      end
+    end
+
+    attr_reader :name, :tree, :trace
 
     def initialize(name, productions, trace)
       @name = name.to_sym
-      @productions = productions
+      @tree = productions
       @trace = trace
     end
 
     def size
-      productions.size
+      tree.size
     end
 
     def evaluate(options)
-      productions.evaluate(options)
+      tree.evaluate(options)
     end
   end
 end

data/lib/calyx/version.rb

@@ -1,3 +1,3 @@
 module Calyx
-  VERSION = '0.20.0'.freeze
+  VERSION = '0.21.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calyx
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -69,71 +70,6 @@ files:
 - README.md
 - SYNTAX.md
 - calyx.gemspec
-- docs/404.html
-- docs/CNAME
-- docs/_config.yml
-- docs/_data/breadcrumbs.yml
-- docs/_data/docs.yml
-- docs/_data/examples.yml
-- docs/_includes/breadcrumbs.html
-- docs/_includes/contents.html
-- docs/_includes/icon-github.html
-- docs/_includes/icon-rubygems.html
-- docs/_includes/navbar.html
-- docs/_includes/pagebar.html
-- docs/_layouts/default.html
-- docs/_layouts/docs.html
-- docs/_layouts/home.html
-- docs/_layouts/page.html
-- docs/_posts/2017-09-14-welcome-to-jekyll.markdown
-- docs/_posts/2017-09-21-0.17.0-released.md
-- docs/_styles/card.scss
-- docs/_styles/colors.scss
-- docs/_styles/content.scss
-- docs/_styles/cta.scss
-- docs/_styles/grid.scss
-- docs/_styles/media.scss
-- docs/_styles/menu.scss
-- docs/_styles/modifiers.scss
-- docs/_styles/navbar.scss
-- docs/_styles/pagebar.scss
-- docs/_styles/reset.scss
-- docs/_styles/scale.scss
-- docs/_styles/spread.scss
-- docs/_styles/styleguide.scss
-- docs/_styles/syntax.scss
-- docs/_styles/typography.scss
-- docs/_styles/yard.scss
-- docs/api.html
-- docs/assets/calyx-docs.css
-- docs/assets/calyx-flower-outline.svg
-- docs/assets/calyx-flower-reverse.svg
-- docs/assets/calyx-flower.svg
-- docs/assets/logo-small.png
-- docs/assets/logos/calyx-flower-1.svg
-- docs/assets/logos/calyx-flower-2.svg
-- docs/content/documentation.html
-- docs/content/examples.html
-- docs/content/examples/any-gradient.md
-- docs/content/examples/faker.md
-- docs/content/examples/tiny-woodland-bot.md
-- docs/content/guides/context.md
-- docs/content/guides/expressions.md
-- docs/content/guides/features.md
-- docs/content/guides/formats.md
-- docs/content/guides/installation.md
-- docs/content/guides/random.md
-- docs/content/guides/results.md
-- docs/content/index.html
-- docs/content/introduction.md
-- docs/content/introduction/concepts.md
-- docs/content/introduction/contributing.md
-- docs/content/introduction/tutorial.md
-- docs/content/styleguide.html
-- docs/docs.scss
-- docs/index.html
-- docs/package-lock.json
-- docs/package.json
 - examples/any_gradient.rb
 - examples/faker.json
 - examples/faker.rb
@@ -142,6 +78,7 @@ files:
 - lib/calyx/errors.rb
 - lib/calyx/format.rb
 - lib/calyx/grammar.rb
+- lib/calyx/mapping.rb
 - lib/calyx/modifiers.rb
 - lib/calyx/options.rb
 - lib/calyx/production/choices.rb
@@ -175,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generate text with declarative recursive grammars

data/docs/404.html

@@ -1,7 +0,0 @@
----
-layout: default
----
-<div class="content">
-  <h1>Not found</h1>
-  <p>Whatever you were looking for is not here.</p>
-</div>

data/docs/CNAME

@@ -1 +0,0 @@
-calyx-rb.org

data/docs/_config.yml

@@ -1,27 +0,0 @@
-title: Calyx
-email: me@maetl.net
-description: >
-  A Ruby library for generating text with template expansion grammars.
-baseurl: "" # the subpath of your site, e.g. /blog
-url: "" # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: maetl
-github_username:  maetl
-
-# Build settings
-markdown: kramdown
-plugins:
-  - jekyll-feed
-
-highlighter: rouge
-
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/

data/docs/_data/breadcrumbs.yml

@@ -1,9 +0,0 @@
-documentation:
-  title: Documentation
-  permalink: /documentation/
-introduction:
-  title: Introduction
-  permalink: /introduction/
-guides:
-  title: Guides
-  permalink: /guides/

data/docs/_data/docs.yml

@@ -1,35 +0,0 @@
-- title: Introduction
-  permalink: /introduction/
-  pages:
-    - title: Tutorial
-      permalink: /introduction/tutorial
-    - title: Key Concepts
-      permalink: /introduction/concepts
-    - title: For Beginners
-      permalink: /introduction/beginners
-    - title: Contributing
-      permalink: /introduction/contributing
-- title: Guides
-  permalink: /guides/
-  pages:
-    - title: Installation
-      permalink: /guides/installation
-    - title: Generating Results
-      permalink: /guides/results
-    - title: Dynamic Rules
-      permalink: /guides/dynamic-rules
-    - title: Template Expressions
-      permalink: /guides/template-expressions
-    - title: Weighted Choices
-      permalink: /guides/weighted-choices
-    - title: Extending Grammars
-      permalink: /guides/extending
-    - title: Random Seeds
-      permalink: /guides/random-seeds
-- title: Reference
-  permalink: /reference/
-  pages:
-    - title: Configuration Options
-      permalink: /reference/config
-    - title: API Listing
-      permalink: /reference/api

data/docs/_data/examples.yml

@@ -1,9 +0,0 @@
-- title: Tiny Woodland Bot
-  description: Minimalist Twitter emoji scenes.
-  permalink: /examples/tiny-woodland-bot
-- title: Any Gradient
-  description: A web service making linear gradients.
-  permalink: /examples/any-gradient
-- title: Faker
-  description: Generates fake names and email addresses.
-  permalink: /examples/faker

data/docs/_includes/breadcrumbs.html

@@ -1,36 +0,0 @@
-<ol itemscope itemtype="http://schema.org/BreadcrumbList">
-
-  {% assign counter=0 %}
-
-  {% for category in site.categories %}
-
-      {% capture category_url %}{{ site.category_dir }}/{{ category | first | slugize | downcase | replace:' ','-' }}{% endcapture %}
-      {% capture category_name %}{{ category | first}}{% endcapture %}
-
-        {% for catpagename in page.categories %}
-          {% if category_name == catpagename %}
-
-          {% assign counter=counter | plus:1 %}
-
-          <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
-             <a itemprop="item" href="{{ site.url }}{{ append:'/' | append:category_url |  append:'/' }}">
-               <span itemprop="name">{{ catpagename }}</span>
-             </a>
-            <meta itemprop="position" content="{{counter}}" />
-          </li>
-
-          {% endif %}
-        {% endfor %}
-
-   {% endfor %}
-
-   {% assign counter=counter | plus:1 %}
-
-  <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
-     <a itemprop="item" href="{{ site.url }}{{ page.url }}">
-       <span itemprop="name">{{ page.title }}</span>
-     </a>
-    <meta itemprop="position" content="{{counter}}" />
-  </li>
-
-</ol>