markovite 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59954d2685196332c680dcad7b09ac470e25fc284035da71fbb9b40898bac750
+  data.tar.gz: abd736b797da4d2b6c25a1d64226e4d0ea402cb861b539d8edbfd0eee2c015cf
+SHA512:
+  metadata.gz: 589de5784a1afe9e2cf25b5cb41c71eafb962646b77c62b4f5bdb358f573cf4891ba933252ee065fadd50ae3cc7ba1a29d06f4f8a47a0cc833b0b5aa16d63746
+  data.tar.gz: a2434e3dd6e04f9946ba5800daf2fdb0826decb23504cc901bd9d73ef88bc389bfc135de74c47b62b8b47656000831026b2a3ede7144ba095cd7768f7e1b4d23

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at superbiscuit@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in markovite.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    markovite (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  markovite!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 f3mshep
+
+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.

data/README.md

@@ -0,0 +1,43 @@
+# Markovite
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/markovite`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'markovite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install markovite
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/f3mshep/markovite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Markovite project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/f3mshep/markovite/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "markovite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/environment.rb

@@ -0,0 +1,4 @@
+require_relative "../lib/markovite/chainer.rb"
+require_relative "../lib/markovite/dict.rb"
+require_relative "../lib/markovite/splitter.rb"
+require_relative "../lib/markovite.rb"

data/lib/markovite.rb

@@ -0,0 +1,86 @@
+require_relative "../config/environment"
+
+module Markovite
+  FILE_EXT = [/.txt\z/i, /.rtf\z/i]
+  class Chain
+    attr_accessor :dictionary, :chainer, :split
+    attr_reader :depth
+    DEFAULT_DEPTH = 2
+    MAX_FILENAME_LENGTH = 255
+
+    def initialize(filename = nil, dict_depth=DEFAULT_DEPTH)
+      parse_file(filename, dict_depth) if filename
+    end
+
+    def parse_string(text, dict_depth=DEFAULT_DEPTH)
+      if chainer
+        add_from_text(text)
+      else
+        new_from_text(text, dict_depth)
+      end
+    end
+
+    def parse_file(filename, dict_depth = DEFAULT_DEPTH)
+      raise "Invalid file type" if !is_valid_file_ext?(filename)
+      text = File.read(filename)
+      parse_string(text, dict_depth)
+    end
+
+    def << (corpus)
+      if is_file?(corpus)
+        parse_file(corpus)
+      else
+        parse_string(corpus)
+      end
+    end
+
+    ####Future Self: Make this a module####
+
+    def split_words(str)
+      str.split(" ")
+    end
+
+    def make_sentence
+      chainer.make_sentence
+    end
+
+    def make_sentences(amount)
+      chainer.make_sentences(amount)
+    end
+
+    def make_sentence_starts_with(phrase)
+      chainer.make_sentence_starts_with(phrase)
+    end
+
+    def make_sentence_of_length(how_long)
+      chainer.make_sentence_of_length(how_long)
+    end
+
+    ####  ####
+
+    private
+
+    def new_from_text(text, dict_depth)
+      #look into refactoring this
+      @depth = dict_depth
+      self.split = SplitSentence.new(text)
+      self.dictionary = Dictionary.new(split, depth)
+      self.chainer = Chainer.new(dictionary)
+    end
+
+    def is_valid_file_ext?(filename)
+      re = Regexp.union(FILE_EXT)
+      filename.match(re)
+    end
+
+    def is_file?(str)
+      str.length < 255 && split_words(str).length == 1
+    end
+
+    def add_from_text(text)
+      dictionary.expand_chain(text)
+    end
+
+  end
+
+end

data/lib/markovite/chainer.rb

@@ -0,0 +1,117 @@
+# class
+class Chainer
+
+  attr_accessor :dictionary
+  attr_reader :depth
+
+  BEGINNING = "__BEGIN__"
+  ENDING = "__END__"
+  MAX_ATTEMPTS = 15
+
+  def initialize(dictionary)
+    self.dictionary = dictionary
+    @depth = dictionary.depth
+    #takes in a dictionary object
+    #constructs chain from dictionary object public interface
+  end
+
+  def make_sentence_starts_with(phrase)
+    chunk = get_chunk(phrase)
+    partial = generate_text(chunk)
+    "#{phrase} #{partial}"
+  end
+
+  def make_sentence_of_length(how_long)
+    make_sentence_with_block {|sentence| sentence.length <= how_long}
+  end
+
+  def make_sentences(amount, condition=true)
+    sentences = []
+    amount.times do
+      sentences << make_sentence(condition)
+    end
+    sentences.join(' ')
+  end
+
+  def depth=(arg)
+    raise "Depth cannot be changed"
+  end
+
+  def make_sentence
+    raise "No corpus in memory" if dictionary.nil?
+    attempts = 0
+    while attempts < MAX_ATTEMPTS
+      sentence = generate_text
+      if is_valid_sentence?(sentence)
+        return sentence
+      else
+        attempts += 1
+      end
+    end
+    nil
+  end
+
+  private
+
+  def make_sentence_with_block
+    attempts = 0
+    while attempts < MAX_ATTEMPTS
+      sentence = make_sentence
+      if yield(sentence)
+        return sentence
+      else
+        attempts += 1
+      end
+    end
+  end
+
+  def get_chunk(phrase)
+    words = phrase.split(' ')
+    chunk = words.last(depth)
+    while chunk.size < depth
+      chunk.unshift(BEGINNING)
+    end
+    chunk
+  end
+
+  def pick_next(words)
+    word_list = dictionary.chain[words]
+    raise "No matching state found" if word_list.empty?
+    word_list.sample
+  end
+
+  def remove_markers(sentence)
+    #removes BEGINNING and ENDING markers
+    sentence.pop
+    sentence.shift(depth)
+  end
+
+  def is_valid_sentence?(sentence)
+    !dictionary.has_sentence(sentence)
+  end
+
+  def has_open_quote?(sentence)
+    count = sentence.count("\"")
+    count.odd?
+  end
+
+  def close_open_quote(sentence)
+    if has_open_quote?(sentence)
+      "#{sentence}\""
+    else
+      sentence
+    end
+  end
+
+  def generate_text(current_chunk = [BEGINNING] * depth)
+    sentence = current_chunk
+    while current_chunk.last != ENDING
+      sentence << pick_next(current_chunk)
+      current_chunk = sentence.last(depth)
+    end
+    remove_markers(sentence)
+    sentence = sentence.join(' ')
+    close_open_quote(sentence)
+  end
+
+end

data/lib/markovite/dict.rb

@@ -0,0 +1,67 @@
+# class that takes a training corpus and creates a hash that represents
+# a markov chain state machine
+
+class Dictionary
+
+  #make this a module???
+  BEGINNING = "__BEGIN__"
+  ENDING = "__END__"
+
+  attr_accessor :chain, :sentence_split, :sentences
+  attr_reader :depth
+  def initialize(sentence_split, depth = 2)
+    self.sentence_split = sentence_split
+    # The following line ensures a new array is created for each new key
+    # instead of using the memory address of the first array created    raise exception "First argument must contain a SplitSentence instance" if sentence_split.class != SentenceSplit
+    # as the default value
+    self.chain = Hash.new { |h, k| h[k] = [] }
+    self.sentences = sentence_split.sentences
+    @depth = depth
+    construct_chain
+  end
+
+  def has_sentence(sentence)
+    sentences.include?(sentence)
+  end
+
+  def depth=(arg)
+    raise "Depth cannot be changed"
+  end
+
+  def expand_chain(text)
+    new_sentences = sentence_split.expand_corpus(text)
+    sentences = sentence_split.sentences
+    construct_chain(new_sentences)
+  end
+
+  def construct_chain(new_sentences = nil)
+    new_sentences = new_sentences || sentences
+    raise "No sentences in memory" if new_sentences.empty?
+    new_sentences.each do |sentence|
+      words = sentence.split(" ")
+      # each chunk is an array that represents a state in the markov chain
+      # it is a key that points to the next possible states
+      chunk = [BEGINNING] * depth
+      words.each do |word|
+        # using a clone of the chunk ensures the VALUE
+        # of the chunk is used as the key, instead of
+        # whatever is stored at the memory address
+        # of the initial chunk
+        chain[chunk.clone] << word
+        chunk.shift
+        chunk.push(word)
+      end
+      chain[chunk] << ENDING
+    end
+    chain
+  end
+
+  def clear_chain
+    chain.clear
+  end
+
+  def clear_sentences
+    sentences.clear
+  end
+
+end

data/lib/markovite/splitter.rb

@@ -0,0 +1,69 @@
+#class that takes a corpus and breaks it down into arrays.
+#each array is one sentence.
+
+class SplitSentence
+
+  SPLITTERS = ['\n', '?', '.', '!']
+
+  #look into detecting abbreviations!
+
+  attr_accessor :sentences, :corpus
+
+  def initialize(corpus)
+    self.corpus = corpus.dup
+    self.sentences = []
+    split_text
+  end
+
+  def clear_sentences
+    sentences.clear
+  end
+
+  # We will want to change this to something that splits the words into an
+  # array, then we will make another pass through the word array to find
+  # where a sentence begins and ends
+
+  # might be cool to count punct. separately, we can point to punct as a way to indicate the end. if the
+  # sentences are delimited by \n, we can have nil be the value it points to instead.
+  # This way, we can impose grammatical rules by making the first word of the sentence
+  # capitalized, and the end of the sentence will end with some sort of punctuation.
+
+
+
+  def split_text(new_text = nil)
+    #not sure how elegant clear_sentence is here
+    clear_sentences unless new_text
+    new_text = new_text || corpus
+    current_sentence = ""
+    new_sentences = []
+    new_text.each_char do |char|
+      if SPLITTERS.include?(char)
+        current_sentence << char
+        new_sentences << current_sentence
+        self.sentences << current_sentence
+        current_sentence = ""
+      else
+        next if current_sentence == "" && char == " "
+        current_sentence << char
+      end
+    end
+    new_sentences
+  end
+
+  def expand_corpus(new_text)
+    corpus << "\n" + new_text
+    split_text(new_text)
+  end
+
+  private
+
+  def is_abbreviation
+  end
+
+  def is_url
+  end
+
+  def is_sentence_end
+  end
+
+end

data/lib/markovite/version.rb

@@ -0,0 +1,3 @@
+module Markovite
+  VERSION = "0.2.1"
+end

data/markovite.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "markovite/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "markovite"
+  spec.version       = Markovite::VERSION
+  spec.authors       = ["Alexandra Wright"]
+  spec.email         = ["superbiscuit@gmail.com"]
+
+  spec.summary       = "A markov chain generator that is simple to use and easy to hack."
+  spec.description   = "Doctors hate this one weird trick that generates really good looking gibberish!"
+  spec.homepage      = "https://github.com/f3mshep/ruby_markovify"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib", "config"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: markovite
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Alexandra Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Doctors hate this one weird trick that generates really good looking
+  gibberish!
+email:
+- superbiscuit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/environment.rb
+- lib/.DS_Store
+- lib/markovite.rb
+- lib/markovite/chainer.rb
+- lib/markovite/dict.rb
+- lib/markovite/splitter.rb
+- lib/markovite/version.rb
+- markovite.gemspec
+- pkg/markovite-0.1.0.gem
+- pkg/markovite-0.2.0.gem
+homepage: https://github.com/f3mshep/ruby_markovify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- config
+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.7.4
+signing_key: 
+specification_version: 4
+summary: A markov chain generator that is simple to use and easy to hack.
+test_files: []