llt-helpers 0.0.4

data/spec/lib/llt/helpers/primitive_cache_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe LLT::Helpers::PrimitiveCache do
+  class Dummy
+    include LLT::Helpers::PrimitiveCache
+  end
+
+  describe "#cached" do
+    it "takes a key and a block, whose result gets cached" do
+      d = Dummy.new
+      d.enable_cache
+      d.cached(:a) { 1 }.should == 1
+      d.cached(:a) { 2 }.should == 1
+    end
+
+    it "is disabled by default" do
+      d = Dummy.new
+      d.cached(:a) { 1 }.should == 1
+      d.cached(:a) { 2 }.should == 2
+    end
+  end
+
+  describe "#cache" do
+    it "returns the hash cache of the class" do
+      d = Dummy.new
+      d.enable_cache
+      d.cached(:a) { 1 }
+      d.cache.should == Dummy.cache
+    end
+
+    it "is shared across instances of a class" do
+      d1 = Dummy.new
+      d2 = Dummy.new
+      d1.enable_cache
+      d2.enable_cache
+      d1.cached(:a) { 1 }
+      d1.cached(:b) { 2 }
+
+      cache = Dummy.cache
+      d1.cache.should == cache
+      d2.cache.should == cache
+    end
+  end
+
+  describe "#enable_cache" do
+    it "enables the cache" do
+      d = Dummy.new
+      d.enable_cache
+      d.cached(:a) { 1 }.should == 1
+      d.cached(:a) { 2 }.should == 1
+    end
+  end
+
+  describe "#disable_cache" do
+    it "disables the cache" do
+      d = Dummy.new
+      d.enable_cache
+      d.cached(:a) { 1 }.should == 1
+      d.cached(:a) { 2 }.should == 1
+
+      d.disable_cache
+      d.cached(:a) { 3 }.should == 3
+    end
+  end
+end

data/spec/lib/llt/helpers/query_methods_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe LLT::Helpers::QueryMethods do
+  class Test
+    extend LLT::Helpers::QueryMethods
+
+    def initialize(type = nil)
+      @type = type
+      @other_type = :noun
+    end
+  end
+
+
+
+  describe ".add_query_methods_for" do
+
+    context "without optional arguments" do
+      it "adds all available query methods deriving from values for a key term as defined in LLT::Constants::Terminology" do
+        Test.add_query_methods_for(:type)
+        t = Test.new
+        t.should respond_to :noun?
+        t.should respond_to :adj?
+        t.should respond_to :adjective?
+      end
+
+      it "checks equality of a normalized value, stashed in an inst var named like the key term" do
+        Test.add_query_methods_for(:type)
+        t = Test.new(:adjective)
+        t.adj?.should be_true
+        t.adjective?.should be_true
+        t.noun?.should be_false
+      end
+    end
+
+    context "with option :use" do
+      it "redirects to another inst var" do
+        Test.add_query_methods_for(:type, use: :@other_type)
+        t = Test.new(:adj)
+        t.adj?.should be_false
+        t.noun?.should be_true
+      end
+    end
+
+    context "with option :delegate_to" do
+      it "delegates the equality check to the given method or variable" do
+        class Dummy
+          def noun?; true;  end
+          def adj?; false; end
+        end
+        Test.add_query_methods_for(:type, delegate_to: :@type)
+        t = Test.new(Dummy.new)
+        t.adj?.should be_false
+        t.noun?.should be_true
+      end
+    end
+
+    context "with options :use and :delegate_to" do
+      it "raises an error" do
+        expect { Test.add_query_methods_for(:type, use: :x, delegate_to: :y) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with a lambda" do
+      it "uses the block to handle the query"
+    end
+  end
+end

data/spec/lib/llt/helpers/roman_numerals_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe LLT::Helpers::RomanNumerals do
+  describe ".roman?" do
+    it "detects if given value is a roman numeral" do
+      subject.roman?("MDCIX").should be_true
+    end
+
+    it "recognizes only fully upcased values as numeral atm" do
+      subject.roman?("mdcix").should be_false
+    end
+
+    it "doesn't match potentially misleading strings like M. for Marcus" do
+      subject.roman?("M.").should be_false
+    end
+  end
+
+  describe ".to_roman" do
+    LLT::Constants::NUMERALS.each do |dec, rom|
+      it "converts #{dec} to #{rom}" do
+        subject.to_roman(dec).should == rom
+      end
+    end
+
+    it "converts 1984 to MCMLXXXIV" do
+      subject.to_roman(1984).should == "MCMLXXXIV"
+    end
+  end
+
+  describe ".to_decimal" do
+    LLT::Constants::NUMERALS.each do |dec, rom|
+      it "converts #{rom} to #{dec}" do
+        subject.to_decimal(rom).should == dec
+      end
+    end
+
+    it "converts MCMLXXXIV to 1984" do
+      subject.to_decimal("MCMLXXXIV").should == 1984
+    end
+  end
+end

data/spec/lib/llt/helpers/terminology_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe LLT::Helpers::Terminology do
+  let(:t) { LLT::Helpers::Terminology }
+
+  describe "#key_term_for" do
+    context "returns a normalized key for category names like tempus" do
+      it "handles different words for inflection_class" do
+        t.key_term_for(:inflectable_class).should == t.inflection_class
+        t.key_term_for(:itype).should == t.inflection_class
+        t.key_term_for(:inflection_class).should == t.inflection_class
+      end
+
+      it "handles different words for tempus" do
+        t.key_term_for(:tense).should == t.tempus
+        t.key_term_for(:tempus).should == t.tempus
+      end
+
+      it "handles different words for casus" do
+        t.key_term_for(:casus).should == t.casus
+        t.key_term_for(:case).should == t.casus
+      end
+
+      it "handles different words for modus" do
+        t.key_term_for(:modus).should == t.modus
+        t.key_term_for(:mood).should == t.modus
+      end
+
+      it "handles different words for modus" do
+        t.key_term_for(:deponens).should == t.deponens
+        t.key_term_for(:dep).should == t.deponens
+      end
+
+      it "normalizes strings to symbols" do
+        t.key_term_for("tempus").should == t.tempus
+      end
+    end
+  end
+
+  describe "#value_term_for" do
+    context "returns a normalized value - a key/category needs to given" do
+      it "handles different tempus names" do
+        t.value_term_for(:tempus, :pr).should == t.pr
+        t.value_term_for(:tempus, :praesens).should == t.pr
+        t.value_term_for(:tempus, :present).should == t.pr
+      end
+
+      it "normalizes strings to symbols" do
+        t.value_term_for(:casus, "nominative").should == t.nom
+      end
+
+      it "normalizes pure digits strings to integers" do
+        t.value_term_for(:inflection_class, '1').should == 1
+
+        # edge case for this hacky solution
+        t.value_term_for(:inflection_class, :esse).should == :esse
+      end
+
+      it "leaves alone Fixnums" do
+        t.value_term_for(:casus, 2).should == t.gen
+      end
+
+      it "leaves alone booleans" do
+        t.value_term_for(:deponens, true).should == true
+        t.value_term_for(:deponens, false).should == false
+      end
+
+      it "tries to normalize the key when initial lookup fails" do
+        t.value_term_for(:case, :acc).should == t.acc
+      end
+    end
+  end
+
+  describe "#values_for" do
+    it "returns all valid values for a given key term" do
+      t.values_for(:type).should include(:noun, :adjective, :adj)
+    end
+
+    it "key term is normalized" do
+      t.values_for(:pos).should include(:noun, :adjective, :adj)
+    end
+  end
+
+  describe "#norm_values_for" do
+    it "returns all values for a key term, that are defined as getter methods - default format is used when not given" do
+      t.norm_values_for(:numerus).should == [1, 2]
+      t.norm_values_for(:numerus, format: :numeric).should == [1, 2]
+      t.norm_values_for(:numerus, format: :abbr).should == [:sg, :pl]
+      t.norm_values_for(:numerus, format: :full).should == [:singularis, :pluralis]
+      t.norm_values_for(:numerus, format: :camelcase).should == [:Singularis, :Pluralis]
+
+      t.norm_values_for(:persona).should == [1, 2, 3]
+    end
+  end
+
+  describe ".method_missing" do
+    it "returns the sent method name name" do
+      t.whatever.should == :whatever
+    end
+  end
+
+  context "contains methods that identify a given terminology standard" do
+    it "returns a camelcases symbol if called with :camelcase" do
+      t.pr(:camelcase).should == :Praesens
+      t.fut_ex(:camelcase).should == :FuturumExactum
+
+    end
+    context "with tempora" do
+      it "returns symbolic value in abbreviated form by default" do
+        t.pr.should == :pr
+      end
+
+      it "returns symbolic value in unabbreviated latin with an argument of false" do
+        t.pr(:full).should == :praesens
+      end
+
+      it "can return a numeric value" do
+        t.pr(:numeric)    .should == 1
+        t.impf(:numeric)  .should == 2
+        t.fut(:numeric)   .should == 3
+        t.pf(:numeric)    .should == 4
+        t.pqpf(:numeric)  .should == 5
+        t.fut_ex(:numeric).should == 6
+      end
+    end
+
+    context "with casus and numerus" do
+      it "returns numeric value of a casus by default" do
+        t.genetivus.should == 2
+        t.ablativus.should == 6
+        t.singularis.should == 1
+      end
+
+      it "methods are aliased to an abbreviated form" do
+        t.gen.should == 2
+        t.dat.should == 3
+        t.pl.should == 2
+      end
+
+      it "returns an abbreviated symbol with an argument of :abbr" do
+        t.accusativus(:abbr).should == :acc
+        t.pl(:abbr).should == :pl
+      end
+
+      it "returns an unabbreviated symbol with an argument of :full" do
+        t.nom(:full).should == :nominativus
+        t.pl(:full).should == :pluralis
+      end
+    end
+
+    context "with sexus" do
+      it "returns a one letter abbreviation by default" do
+        t.m.should == :m
+        t.f.should == :f
+        t.n.should == :n
+      end
+
+      it "can return a numeric value" do
+        t.m(:numeric).should == 1
+        t.f(:numeric).should == 2
+        t.n(:numeric).should == 3
+      end
+    end
+  end
+end

data/spec/lib/llt/helpers/transformer_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe LLT::Helpers::Transformer do
+  class Dummy
+    include LLT::Helpers::Transformer
+
+    def initialize
+      @a = 1
+      @b = 2
+      @c = 3
+    end
+  end
+
+  let(:dummy) { Dummy.new }
+
+  describe "#to_hash" do
+    it "maps all instance variables to key/value pairs" do
+      dummy.to_hash.should == { a: 1, b: 2, c: 3 }
+    end
+
+    it "root node can be given" do
+      dummy.to_hash(root: "a_root").should == { "a_root" => { a: 1, b: 2, c: 3 } }
+    end
+
+    it "if root node is given as instance of TrueClass, the class name gets used as root node" do
+      dummy.to_hash(root: true).should == { "Dummy" =>  { a: 1, b: 2, c: 3 } }
+    end
+
+    it "if symbols are given in a whitelist, only corresponding values will get returned" do
+      dummy.to_hash(whitelist: [:a, :b]).should == { a: 1, b: 2 }
+    end
+
+    it "if symbols are given in a blacklist, these values will be skipped" do
+      dummy.to_hash(blacklist: [:b]).should == { a: 1, c: 3 }
+    end
+
+    it "default type for keys are symbols, can be manipulated with keys: #method" do
+      dummy.to_hash(whitelist: [:a], keys: :to_s).should == { "a" => 1 }
+    end
+
+    it "custom contents can be given" do
+      dummy.to_hash(custom: { a: 5 }, whitelist: [:b]).should == { a: 5, b: 2 }
+    end
+
+    it "custom contents would still be inside a root node" do
+      dummy.to_hash(custom: { a: 5 }, blacklist: [:b, :c], root: :root).should == { root: { a: 5 } }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'llt/helpers'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: llt-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- LFDM
+- lichtr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: llt-constants
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: LLT Helpers
+email:
+- 1986gh@gmail.com
+- robert.lichtensteiner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/llt/helpers.rb
+- lib/llt/helpers/configuration.rb
+- lib/llt/helpers/constantize.rb
+- lib/llt/helpers/equality.rb
+- lib/llt/helpers/functions.rb
+- lib/llt/helpers/initialize.rb
+- lib/llt/helpers/metrical.rb
+- lib/llt/helpers/normalizer.rb
+- lib/llt/helpers/pluralize.rb
+- lib/llt/helpers/positions.rb
+- lib/llt/helpers/primitive_cache.rb
+- lib/llt/helpers/query_methods.rb
+- lib/llt/helpers/roman_numerals.rb
+- lib/llt/helpers/terminology.rb
+- lib/llt/helpers/transformer.rb
+- lib/llt/helpers/version.rb
+- llt-helpers.gemspec
+- spec/lib/llt/helpers/configuration_spec.rb
+- spec/lib/llt/helpers/constantize_spec.rb
+- spec/lib/llt/helpers/equality_spec.rb
+- spec/lib/llt/helpers/functions_spec.rb
+- spec/lib/llt/helpers/initialize_spec.rb
+- spec/lib/llt/helpers/metrical_spec.rb
+- spec/lib/llt/helpers/normalizer_spec.rb
+- spec/lib/llt/helpers/pluralize_spec.rb
+- spec/lib/llt/helpers/positions_spec.rb
+- spec/lib/llt/helpers/primitive_cache_spec.rb
+- spec/lib/llt/helpers/query_methods_spec.rb
+- spec/lib/llt/helpers/roman_numerals_spec.rb
+- spec/lib/llt/helpers/terminology_spec.rb
+- spec/lib/llt/helpers/transformer_spec.rb
+- spec/spec_helper.rb
+homepage: http://christof.github.io/llt
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Helper modules used by several llt gems
+test_files:
+- spec/lib/llt/helpers/configuration_spec.rb
+- spec/lib/llt/helpers/constantize_spec.rb
+- spec/lib/llt/helpers/equality_spec.rb
+- spec/lib/llt/helpers/functions_spec.rb
+- spec/lib/llt/helpers/initialize_spec.rb
+- spec/lib/llt/helpers/metrical_spec.rb
+- spec/lib/llt/helpers/normalizer_spec.rb
+- spec/lib/llt/helpers/pluralize_spec.rb
+- spec/lib/llt/helpers/positions_spec.rb
+- spec/lib/llt/helpers/primitive_cache_spec.rb
+- spec/lib/llt/helpers/query_methods_spec.rb
+- spec/lib/llt/helpers/roman_numerals_spec.rb
+- spec/lib/llt/helpers/terminology_spec.rb
+- spec/lib/llt/helpers/transformer_spec.rb
+- spec/spec_helper.rb