rubykov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bdb3e4295782a7bf03967d2f4de67aef65fa64b
+  data.tar.gz: 16e45e2b424bb261476afc2dae7619af27f9bcb6
+SHA512:
+  metadata.gz: 3570f5ad7f21b459e7f31575b08b4dd27e799189c081b54352bdc2d0bdf5ff04d0672efb664896eec00787951394cc5953c151cb659f7e87b1269ff7dee71a3f
+  data.tar.gz: 8b0fd9ba3513aaf47e58e66bd0f7a252df8a529c29cd45f43ea00547b5782784a502c8deadaed6af757ca1ad4f80f1315378fe22b72a6733fcfaed20f1a885d3

data/README.md

@@ -0,0 +1,40 @@
+### Rubykov
+
+Sensible, easy Markov chains in Ruby.
+
+## Usage
+
+Markov models are generated by an order and a set of training data.
+
+For example, to create a first-order Markov model given some weather data:
+
+```
+markov_model = Rubykov::MarkovModel.new(1, ['sunny','rainy','sunny','sunny','sunny','windy','sunny','rainy','windy','rainy'])
+```
+
+To obtain predictions, use the chain method, which returns an enumerator:
+
+```
+markov_chain = markov_model.chain
+markov_chain.next
+=> "sunny"
+```
+
+There is a text generator subclass which has useful methods for outputting character- and word-limited strings.
+The following is a second-order Markov model:
+
+```
+text_generator = Rubykov::TextGenerator.new(2, 'The quick brown fox jumps over the brown fox who is slow jumps over the brown fox who is dead.')
+text_generator.character_limited_output(140)
+=> "The quick brown fox who is dead."
+```
+
+## Testing
+
+To run the test suite simply execute:
+
+```
+rspec
+```
+
+(c) Evan Hemsley 2014

data/lib/rubykov/markov_model.rb

@@ -0,0 +1,48 @@
+module Rubykov
+  class MarkovModel
+    def initialize(order, training_data)
+      raise ArgumentError unless order.is_a? Integer
+      raise ArgumentError unless training_data.is_a? Array
+      chain_data = {}.tap do |representation|
+        training_data.each_cons(order + 1).each do |datum|
+          key = datum.first(order)
+          value = datum.last
+          if representation.include? key
+            representation[key] << value
+          else
+            representation[key] = [value]
+          end
+        end
+      end
+      @order = order
+      @representation = chain_data
+    end
+
+    def chain
+      Enumerator.new do |y|
+        current_state = @representation.keys.sample
+        current_state.each do |word|
+          y << word
+        end
+
+        loop do
+          if @representation[current_state].nil?
+            break
+          else
+            next_word = @representation[current_state].sample
+            y << next_word
+            current_state = current_state.last(@order-1) + [next_word]
+          end
+        end
+      end
+    end
+
+    def states
+      @representation.keys
+    end
+
+    def transitions
+      @representation
+    end
+  end
+end

data/lib/rubykov/text_generator.rb

@@ -0,0 +1,19 @@
+module Rubykov
+  class TextGenerator < MarkovModel
+    def initialize(order, training_text)
+      super(order, training_text.downcase.gsub('.', ' .').split(' '))
+    end
+
+    def character_limited_output(desired_length)
+      length = 0
+      chain.take_while do |word|
+        length += (word.length + 1)
+        length < desired_length
+      end.join(' ').gsub(' .', '.').capitalize
+    end
+
+    def word_limited_output(desired_length)
+      chain.take(desired_length).join(' ').gsub(' .', '.').capitalize
+    end
+  end
+end

data/lib/rubykov.rb

@@ -0,0 +1,2 @@
+require 'rubykov/markov_model'
+require 'rubykov/text_generator'

data/license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <2014> <Evan Hemsley>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rubykov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evan Hemsley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: This gem defines Markov model-related classes.
+email: evan.hemsley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rubykov.rb
+- lib/rubykov/markov_model.rb
+- lib/rubykov/text_generator.rb
+- license.md
+homepage: https://gitlab.com/ehemsley/rubykov
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sensible, easy Markov models in Ruby.
+test_files: []