verbs 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3cb83b9097ea8bf2c6535df39c6bec057723e6ba9d9656fea24d07c408669d
-  data.tar.gz: 843f283457646d40e231aca31596583bf6d6de0aa010475fbc69646b08e4f4f8
+  metadata.gz: 46ce7e5cfe62a82289b8c7770e9bf9905106d776c960a309007b41782bf1b6fa
+  data.tar.gz: f92d5047b6743da58b2669744fd04e6400e913c2c7221b83f657b8f2f39cef25
 SHA512:
-  metadata.gz: ce1045dc949010c62482dc97a5d65964d12779a772855cac9fe504cc7e26b9e735281934926b13306f43dc843cba58bae7088b2548a7211b7416756471d8fdf8
-  data.tar.gz: 8dc5fb226b59469fb5264210dcc88ed7dad49ed568f02b603299ee8cd0815a161512860a8b4315cd81c9ecea6a918238bc3736c6b8cf7f87d526e0d20183288e
+  metadata.gz: aff4a218c912eaa3266f416e79b2de1420179e3c282ef30777d155a84560d83cade09d850a85ae546a8f52f714372cd7a1a2f4daa4140e52c68dd24da757221b
+  data.tar.gz: '0798baa0c945dad303ac4c8c569f7a7d30bd55faa50d40f09168983ed4868ea18d214f55dea71a6f81336bec04f64a0b1a6a58eee11bfec8e2d65b11322974fc'

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 rake

data/README.rdoc

@@ -47,7 +47,7 @@ Set this to a string to prepend the conjugated verb with it. When set to tru
 
   EXAMPLE                   TENSE    ASPECT
   
-  I usually accepted        past     habitual
+  I used to accept          past     habitual
   I had accepted            past     perfect
   I accepted                past     perfective
   I was accepting           past     progressive

data/Rakefile

@@ -14,9 +14,6 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-require 'bueller'
-Bueller::Tasks.new
-
 require 'rake'
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|

data/lib/verbs/conjugations.rb

@@ -4,11 +4,13 @@ Verbs::Conjugator.conjugations do |conjugate|
     verb.form :am,    :tense => :present, :person => :first,  :plurality => :singular
     verb.form :is,    :tense => :present, :person => :third,  :plurality => :singular
     verb.form :are,   :tense => :present, :person => :second, :plurality => :singular
+    verb.form :are,   :tense => :present, :person => :second, :plurality => :plural
     verb.form :are,   :tense => :present, :person => :first,  :plurality => :plural
     verb.form :are,   :tense => :present, :person => :third,  :plurality => :plural
     verb.form :was,   :tense => :past,    :person => :first,  :plurality => :singular
     verb.form :was,   :tense => :past,    :person => :third,  :plurality => :singular
     verb.form :were,  :tense => :past,    :person => :second, :plurality => :singular
+    verb.form :were,  :tense => :past,    :person => :second, :plurality => :plural
     verb.form :were,  :tense => :past,    :person => :first,  :plurality => :plural
     verb.form :were,  :tense => :past,    :person => :third,  :plurality => :plural
     verb.form :were,  :tense => :past,    :mood => :subjunctive
@@ -21,11 +23,13 @@ Verbs::Conjugator.conjugations do |conjugate|
     verb.form :have,   :tense => :present, :person => :first,  :plurality => :singular
     verb.form :has,    :tense => :present, :person => :third,  :plurality => :singular
     verb.form :have,   :tense => :present, :person => :second, :plurality => :singular
+    verb.form :have,   :tense => :present, :person => :second, :plurality => :plural
     verb.form :have,   :tense => :present, :person => :first,  :plurality => :plural
     verb.form :have,   :tense => :present, :person => :third,  :plurality => :plural
     verb.form :had,    :tense => :past,    :person => :first,  :plurality => :singular
     verb.form :had,    :tense => :past,    :person => :third,  :plurality => :singular
     verb.form :had,    :tense => :past,    :person => :second, :plurality => :singular
+    verb.form :had,    :tense => :past,    :person => :second, :plurality => :plural
     verb.form :had,    :tense => :past,    :person => :first,  :plurality => :plural
     verb.form :had,    :tense => :past,    :person => :third,  :plurality => :plural
     verb.form :having, :tense => :present, :derivative => :participle

data/lib/verbs/conjugator.rb

@@ -1,31 +1,60 @@
+# The program conjugates most common english verbs with the following option:
+# * :tense => :past or :present or :future
+# * :person => :first or :second or :third
+# * :plurality => :singular or :plural
+# * :aspect => :habitual or :perfect or :perfective or :progressive or :prospective
+# * :mood => :indicative or :imperative or :subjunctive
+# Respective defaults are :present, :third, :singular, :habitual, and :indicative
+#
+# Author::    Andy Rossmeissl
+# Copyright:: Copyright (c) 2009 Andy Rossmeissl
+# License::   Found in LICENSE file
+
 module Verbs
   module Conjugator
     extend self
 
+    # This class determines the conjugations from the given options (or defaults)
+    # conjugations are then applied to the verb
     class Conjugations
       include Singleton
 
+      # permit outside functions access to these variables
       attr_reader :irregulars, :single_terminal_consonants, :copulars
 
+      # Creates initial variables for class
       def initialize
         @irregulars, @single_terminal_consonants, @copulars = {}, [], {}
       end
 
+      # Determines irregular verbs from the expression
+      # Params:
+      # * infinitive, the given verb
+      # * preterite, denote events that took place in the past
+      # * past_participle, form of a verb, ending in 'ed'
+      # * &blk, block of code that may be run
       def irregular(infinitive, preterite = nil, past_participle = nil, &blk)
         if block_given?
+          # create new Verb object with infinitive and &blk
           irregular = ::Verbs::Verb.new infinitive, &blk
         else
           raise ArgumentError, "Standard irregular verbs must specify preterite and past participle forms" unless preterite and past_participle
+          # create new Verb object with infinitive, preterite and past_participle
           irregular = ::Verbs::Verb.new infinitive, :preterite => preterite, :past_participle => past_participle
         end
         @irregulars[infinitive] = irregular
       end
 
+      # Find single terminal consonant with the infinitive
+      # Params:
+      # * infinitive, the given verb
       def single_terminal_consonant(infinitive)
         @single_terminal_consonants << infinitive
       end
     end
 
+    # Runs a block of code if given in a class instance
+    # else only class instance is created
     def conjugations
       if block_given?
         yield Conjugations.instance
@@ -34,9 +63,15 @@ module Verbs
       end
     end
 
+    # Using options given, determine the conjugation and the subject
+    # Return the subject, if there is one, and the proper conjugation
+    # Params:
+    # * infinitive, the given verb
+    # * options, the list of parameters to alter the conjugation
     def conjugate(infinitive, options = {})
       infinitive = infinitive.dup if infinitive.is_a?(String)
 
+      # set all options according to parameter, or the default
       tense = options[:tense] ||         :present    # present, past, future
       person = options[:person] ||       :third      # first, second, third
       plurality = options[:plurality] || :singular   # singular, plural
@@ -44,20 +79,24 @@ module Verbs
       mood = options[:mood] ||           :indicative # imperative, subjunctive
       aspect = options[:aspect] ||       :habitual   # perfective, habitual, progressive, perfect, prospective
 
-      check_for_improper_constructions(tense, person, mood)
-
-      form = form_for(tense, aspect)
+      check_for_improper_constructions(tense, person, mood)   # find incompatabilities
+      form = form_for(tense, aspect)                          # find form array based on tense and aspect
 
+      # map form array to conjugation array, applying infinitive and options to the array
       conjugation = form.map { |e| resolve e, infinitive, tense, person, plurality, mood }.join(' ').strip
 
-      if options[:subject]
-        actor = options.delete(:subject)
+      if options[:subject]                   # When options includes a subject,
+        actor = options.delete(:subject)     # remove from options and make subject humanized
         actor = subject(options).humanize if actor.is_a?(TrueClass)
       end
 
       "#{actor} #{conjugation}".strip
     end
 
+    # Finds the pronoun associated with the subject for the conjugation
+    # Returns the pronoun
+    # Params:
+    # * options, list of options given to determine conjugation
     def subject(options)
       case [options[:person], options[:plurality]]
       when [:first, :singular]
@@ -75,6 +114,14 @@ module Verbs
 
     private
 
+    # Resolves conflictions between options of the conjugation
+    # Params:
+    # * element,
+    # * infinitive, the given verb
+    # * tense, an option given by the user
+    # * person, an option given by the user
+    # * plurality, an option given by the user
+    # * mood, an option given by the user
     def resolve(element, infinitive, tense, person, plurality, mood)
       case element
       when String
@@ -88,6 +135,13 @@ module Verbs
       end
     end
 
+    # Change the form to express the proper grammatical function
+    # Params:
+    # * infinitive,the given verb
+    # * inflection, form to be changed
+    # * person, an option given by the user
+    # * plurality, an option given by the user
+    # * mood, an option given by the user
     def inflect(infinitive, inflection, person, plurality, mood)
       send(*([inflection, infinitive, person, plurality, mood][0, method(inflection).arity + 1]))
     end
@@ -102,6 +156,12 @@ module Verbs
       end
     end
 
+    # Conjugate verb to past with relevent options determining outcome
+    # Params:
+    # * infinitive, the given verb
+    # * person, the subject of the verb
+    # * plurality, an option given by the user
+    # * mood, an option given by the user
     def past(infinitive, person, plurality, mood)
       if verb = conjugations.irregulars[infinitive]
         conjugate_irregular(verb, :tense => :past, :person => person, :plurality => plurality, :mood => mood)
@@ -110,6 +170,9 @@ module Verbs
       end
     end
 
+    # Forming verb to apply present tense endings
+    # Params:
+    # * infinitive, the given verb
     def present_participle(infinitive)
       if infinitive.to_s.match(/#{CONSONANT_PATTERN}#{VOWEL_PATTERN}#{CONSONANT_PATTERN}$/) and !conjugations.single_terminal_consonants.include?(infinitive.to_sym)
         present_participle_with_doubled_terminal_consonant_for infinitive
@@ -126,6 +189,9 @@ module Verbs
       end
     end
 
+    # Forming verb to apply past tense endings
+    # Params:
+    # * infinitive, the given verb
     def past_participle(infinitive)
       if verb = conjugations.irregulars[infinitive]
         conjugate_irregular(verb, :tense => :past, :derivative => :participle)
@@ -134,6 +200,10 @@ module Verbs
       end
     end
 
+    # 
+    # Params:
+    # * verb, 
+    # * options, 
     def conjugate_irregular(verb, options)
       return verb[options] if verb[options]
 
@@ -153,6 +223,9 @@ module Verbs
       end
     end
 
+    # Apply thir person rules to the verb for the conjugation
+    # Params:
+    # * verb, apply proper third person rules to this
     def present_third_person_singular_form_for(verb)
       infinitive = verb.is_a?(Verb) ? verb.infinitive.to_s : verb.to_s
 
@@ -167,6 +240,9 @@ module Verbs
       end
     end
 
+    # Apply the regular past tense to a given verb for the conjugation
+    # Params:
+    # * verb, apply regular past tense rules to this
     def regular_preterite_for(verb)
       infinitive = verb.is_a?(Verb) ? verb.infinitive.to_s : verb.to_s
 
@@ -181,14 +257,24 @@ module Verbs
       end
     end
 
+    # Apply proper rules to consonant endings
+    # Params:
+    # * verb, apply doule consonant to this
     def regular_preterite_with_doubled_terminal_consonant_for(verb)
       regular_preterite_for verb.to_s.concat(verb.to_s[-1,1]).to_sym
     end
 
+    # Apply proper rules to consonant endings
+    # Params:
+    # * verb, apply doule consonant to this
     def present_participle_with_doubled_terminal_consonant_for(verb)
       present_participle verb.to_s.concat(verb.to_s[-1,1]).to_sym
     end
 
+    # Add appropriate aspects to the tense of the conjugation
+    # Params:
+    # * tense, an option given by the user
+    # * aspect, an option given by the user
     def form_for(tense, aspect)
       form = []
       if tense == :future
@@ -199,7 +285,7 @@ module Verbs
         form.concat ['be', :present_participle] if aspect == :progressive
         form.concat ['be about to', :infinitive] if aspect == :prospective
       else
-        form.concat ['usually', :past_participle] if [tense, aspect] == [:past, :habitual]
+        form.concat ['used to', :infinitive] if [tense, aspect] == [:past, :habitual]
         form.concat [:have, :past_participle] if aspect == :perfect
         form << :past if [tense, aspect] == [:past, :perfective]
         form.concat [:be, :present_participle] if aspect == :progressive
@@ -210,6 +296,11 @@ module Verbs
       form
     end
 
+    # Confirm an imperative mood contains the present tense and second person
+    # Params:
+    # * tense, an option given by the user
+    # * person, how the conjugation refers to the subject
+    # * mood, an option given by the user
     def check_for_improper_constructions(tense, person, mood)
       if mood == :imperative and not (person == :second and tense == :present)
         raise Verbs::ImproperConstruction, 'The imperative mood requires present tense and second person'

data/lib/verbs/version.rb

@@ -1,3 +1,3 @@
 module Verbs
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/test/test_verbs.rb

@@ -2,11 +2,20 @@ require 'helper'
 
 class TestVerbs < Test::Unit::TestCase
   def test_copular_conjugation
+    # present habitual
     assert_equal 'am', Verbs::Conjugator.conjugate(:be, :tense => :present, :person => :first, :plurality => :singular, :aspect => :habitual)
     assert_equal 'are', Verbs::Conjugator.conjugate(:be, :tense => :present, :person => :second, :plurality => :singular, :aspect => :habitual)
     assert_equal 'is', Verbs::Conjugator.conjugate(:be, :tense => :present, :person => :third, :plurality => :singular, :aspect => :habitual)
     assert_equal 'are', Verbs::Conjugator.conjugate(:be, :tense => :present, :person => :first, :plurality => :plural, :aspect => :habitual)
     assert_equal 'are', Verbs::Conjugator.conjugate(:be, :tense => :present, :person => :third, :plurality => :plural, :aspect => :habitual)
+
+    # past habitual
+    assert_equal 'used to be', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :first, :plurality => :singular, :aspect => :habitual)
+    assert_equal 'used to be', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :second, :plurality => :singular, :aspect => :habitual)
+    assert_equal 'used to be', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :third, :plurality => :singular, :aspect => :habitual)
+    assert_equal 'used to be', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :first, :plurality => :plural, :aspect => :habitual)
+    assert_equal 'used to be', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :third, :plurality => :plural, :aspect => :habitual)
+
     assert_equal 'was', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :first, :plurality => :singular, :aspect => :perfective)
     assert_equal 'were', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :second, :plurality => :singular, :aspect => :perfective)
     assert_equal 'was', Verbs::Conjugator.conjugate(:be, :tense => :past, :person => :third, :plurality => :singular, :aspect => :perfective)
@@ -103,7 +112,7 @@ class TestVerbs < Test::Unit::TestCase
   end
   def test_aspects
     Verbs::Conjugator.with_options :person => :first, :plurality => :singular, :subject => true do |standard|
-      assert_equal 'I usually accepted',        standard.conjugate(:accept, :tense => :past, :aspect => :habitual)
+      assert_equal 'I used to accept',        standard.conjugate(:accept, :tense => :past, :aspect => :habitual)
       assert_equal 'I had accepted',            standard.conjugate(:accept, :tense => :past, :aspect => :perfect)
       assert_equal 'I accepted',                standard.conjugate(:accept, :tense => :past, :aspect => :perfective)
       assert_equal 'I was accepting',           standard.conjugate(:accept, :tense => :past, :aspect => :progressive)
@@ -156,4 +165,13 @@ class TestVerbs < Test::Unit::TestCase
     Verbs::Conjugator.conjugate(verb, :tense => :past, :aspect => :perfective)
     assert_equal 'like', verb
   end
+
+  def test_second_person_plural_forms
+    Verbs::Conjugator.with_options :person => :second, :plurality => :plural, :subject => true do |standard|
+      assert_equal 'You had accepted',            standard.conjugate(:accept, :tense => :past, :aspect => :perfect)
+      assert_equal 'You accepted',                standard.conjugate(:accept, :tense => :past, :aspect => :perfective)
+      assert_equal 'You were accepting',           standard.conjugate(:accept, :tense => :past, :aspect => :progressive)
+      assert_equal 'You were about to accept',     standard.conjugate(:accept, :tense => :past, :aspect => :prospective)
+    end
+  end
 end

data/verbs.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_development_dependency 'bueller'
   s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'rake'
   s.add_dependency 'activesupport', '>= 2.3.4'
   s.add_dependency 'i18n'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verbs
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Andy Rossmeissl
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bueller
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE