calyx 0.17.1 → 0.18.0

data/docs/about.md

@@ -1,18 +0,0 @@
----
-layout: page
-title: About
-permalink: /about/
----
-
-This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
-
-You can find the source code for Minima at GitHub:
-[jekyll][jekyll-organization] /
-[minima](https://github.com/jekyll/minima)
-
-You can find the source code for Jekyll at GitHub:
-[jekyll][jekyll-organization] /
-[jekyll](https://github.com/jekyll/jekyll)
-
-
-[jekyll-organization]: https://github.com/jekyll

data/docs/calyx-docs.scss

@@ -1,66 +0,0 @@
-$green: #218764;
-
-$family-monospace: "Oxygen Mono", "Monaco", Inconsolata, monospace;
-$family-sans-serif: "Libre Franklin", sans-serif;
-
-$background: #fafafa;
-
-$content-pre-padding: 0;
-$content-heading-color: #218764;
-$content-heading-weight: 700;
-
-$navbar-item-color: #fff;
-$navbar-background-color: #1BDE81;
-$navbar-item-hover-color: $navbar-item-color;
-$navbar-item-hover-background-color: darken($navbar-background-color, 6%);
-$navbar-item-active-background-color: #1BDE81;
-
-@import "bulma";
-@import "syntax";
-@import "styleguide";
-
-body {
-  font-weight: 500;
-  height: 100%;
-  background-color: $background;
-}
-
-.sidebar {
-  background-color: #eee;
-  height: calc(100vh - 3.25rem);
-}
-
-.navbar-item {
-  font-weight: 500;
-}
-
-.navbar-brand {
-  .navbar-item {
-    font-family: "Work Sans";
-    font-weight: 800;
-    font-size: 24px;
-    line-height: 24px;
-
-    span {
-      margin-left: 6px;
-    }
-  }
-}
-
-.content {
-  h1, h2, h3 {
-    letter-spacing: -1px;
-    font-family: "Work Sans";
-    font-weight: 700;
-  }
-
-  .highlighter-rouge {
-    margin-bottom: 1rem;
-  }
-
-  pre {
-    code {
-      font-size: 1em;
-    }
-  }
-}

data/docs/guide/examples.md

@@ -1,59 +0,0 @@
----
-layout: default
-title: Examples
-permalink: /examples/
----
-
-# Examples
-
-The best way to get started quickly is to install the gem and run the examples locally.
-
-## Any Gradient
-
-Requires Roda and Rack to be available.
-
-```
-gem install roda
-```
-
-Demonstrates how to use Calyx to construct SVG graphics. **Any Gradient** generates a rectangle with a linear gradient of random colours.
-
-Run as a web server and preview the output in a browser (`http://localhost:9292`):
-
-```
-ruby examples/any_gradient.rb
-```
-
-Or generate SVG files via a command line pipe:
-
-```
-ruby examples/any_gradient > gradient1.xml
-```
-
-## Tiny Woodland Bot
-
-Requires the Twitter client gem and API access configured for a specific Twitter handle.
-
-```
-gem install twitter
-```
-
-Demonstrates how to use Calyx to make a minimal Twitter bot that periodically posts unique tweets. See [@tiny_woodland on Twitter](https://twitter.com/tiny_woodland) and the [writeup here](http://maetl.net/notes/storyboard/tiny-woodlands).
-
-```
-TWITTER_CONSUMER_KEY=XXX-XXX
-TWITTER_CONSUMER_SECRET=XXX-XXX
-TWITTER_ACCESS_TOKEN=XXX-XXX
-TWITTER_CONSUMER_SECRET=XXX-XXX
-ruby examples/tiny_woodland_bot.rb
-```
-
-## Faker
-
-[Faker](https://github.com/stympy/faker) is a popular library for generating fake names and associated sample data like internet addresses, company names and locations.
-
-This example demonstrates how to use Calyx to reproduce the same functionality using custom lists defined in a YAML configuration file.
-
-```
-ruby examples/faker.rb
-```

data/docs/guide/getting-started.md

@@ -1,129 +0,0 @@
----
-layout: default  
-title: Getting Started
-permalink: /getting-started/
----
-
-# Getting Started
-
-Require the library and inherit from `Calyx::Grammar` to construct a set of rules to generate a text.
-
-```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 by adding additional rules which provide a named set of text strings. The rule delimiter syntax (`{}`) can be used to substitute the generated content of other rules.
-
-```ruby
-class HelloWorld < Calyx::Grammar
-  start '{greeting} world.'
-  greeting 'Hello', 'Hi', 'Hey', 'Yo'
-end
-```
-
-Each time `#generate` runs, it evaluates the tree and randomly selects variations of rules to construct a resulting string.
-
-```ruby
-hello = HelloWorld.new
-
-hello.generate
-# > "Hi world."
-
-hello.generate
-# > "Hello world."
-
-hello.generate
-# > "Yo world."
-```
-
-By convention, the `start` rule specifies the default starting point for generating the final text. You can start from any other named rule by passing it explicitly to the generate method.
-
-```ruby
-class HelloWorld < Calyx::Grammar
-  hello 'Hello world.'
-end
-
-hello = HelloWorld.new
-hello.generate(:hello)
-```
-
-## Block Constructors
-
-As an alternative to subclassing, you can also construct rules unique to an instance by passing a block when initializing the class:
-
-```ruby
-hello = Calyx::Grammar.new do
-  start '{greeting} world.'
-  greeting 'Hello', 'Hi', 'Hey', 'Yo'
-end
-
-hello.generate
-```
-
-## Template Expressions
-
-Basic rule substitution uses single curly brackets as delimiters for template expressions:
-
-```ruby
-fruit = Calyx::Grammar.new do
-  start '{colour} {fruit}'
-  colour 'red', 'green', 'yellow'
-  fruit 'apple', 'pear', 'tomato'
-end
-
-6.times { fruit.generate }
-# => "yellow pear"
-# => "red apple"
-# => "green tomato"
-# => "red pear"
-# => "yellow tomato"
-# => "green apple"
-```
-
-## Nesting and Substitution
-
-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}.'
-  greeting 'Hello', 'Hi', 'Hey', 'Yo'
-  world_phrase '{happy_adj} world', '{sad_adj} world', 'world'
-  happy_adj 'wonderful', 'amazing', 'bright', 'beautiful'
-  sad_adj 'cruel', 'miserable'
-end
-```
-
-Nesting and hierarchy can be manipulated to balance consistency with novelty. The exact same word atoms can be combined in a variety of ways to produce strikingly different resulting texts.
-
-```ruby
-module HelloWorld
-  class Sentiment < Calyx::Grammar
-    start '{happy_phrase}', '{sad_phrase}'
-    happy_phrase '{happy_greeting} {happy_adj} world.'
-    happy_greeting 'Hello', 'Hi', 'Hey', 'Yo'
-    happy_adj 'wonderful', 'amazing', 'bright', 'beautiful'
-    sad_phrase '{sad_greeting} {sad_adj} world.'
-    sad_greeting 'Goodbye', 'So long', 'Farewell'
-    sad_adj 'cruel', 'miserable'
-  end
-
-  class Mixed < Calyx::Grammar
-    start '{greeting} {adj} world.'
-    greeting 'Hello', 'Hi', 'Hey', 'Yo', 'Goodbye', 'So long', 'Farewell'
-    adj 'wonderful', 'amazing', 'bright', 'beautiful', 'cruel', 'miserable'
-  end
-end
-```

data/docs/guide/installation.md

@@ -1,19 +0,0 @@
----
-layout: default
-title: Install
-permalink: /installation/
----
-
-# Install
-
-## Command Line
-
-```
-gem install calyx
-```
-
-## Gemfile
-
-```
-gem 'calyx'
-```