multitype 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31fd13aa6edb45c77dff6a27f1f0e86205b26058
+  data.tar.gz: 34651ec1ffb2ae2067988b8bbd3d39a17ba0e16f
+SHA512:
+  metadata.gz: 6453bac963334d070f745ae156e3030c30c4a0a9e03192b14d06fe17c5d5632516bf9268d7f579526af7851ba9961c704dec0c9719ed50516a7b061cdd9015d2
+  data.tar.gz: c48478da8607993dfd77103094fff64eca7c8fc2df102e5ad55c671e85352bde606d10908cbd9ee31a199e4f1c938c12e5de0c1eebe6d3d0cd4f403336061dec

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--profile
+--backtrace

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multitype.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kelly Becker
+
+MIT License
+
+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,32 @@
+# Multitype
+
+Allows for variable methods and attributes on models and classes to help differentiate different types of calculations for similar data structures seamlessly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multitype'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multitype
+
+## Usage
+
+Please refer to the specs and the "FakeModel" for basic usage.
+
+- [FakeModel](http://github.com/JIFFinc/multitype/blob/master/spec/support/fake_model.rb)
+- [Spec](http://github.com/JIFFinc/multitype/blob/master/spec/tests/multitype_spec.rb)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/multitype/version.rb

@@ -0,0 +1,3 @@
+module Multitype
+  VERSION = "0.0.1"
+end

data/lib/multitype.rb

@@ -0,0 +1,241 @@
+require "active_support/core_ext/class/attribute"
+require "multitype/version"
+require "awesome_print"
+
+module Multitype
+
+  class NoTypeError < NoMethodError; end
+  class NoTypeCatError < NoTypeError; end
+  class NoTypeSetError < NoTypeError; end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Return the multitype data from the cache
+  [:comparators, :typesets].each do |method|
+    __send__(:define_method, "get_multitype_#{method}") do |type|
+      __get_multitype_cache__(type, method)
+    end
+  end
+
+  # Forward this method to the class method
+  def __get_multitype_cache__(*args)
+    self.class.__get_multitype_cache__(*args)
+  end
+
+  module ClassMethods
+
+    def type_comparator(type, *comparators)
+      __send__(:attr_accessor, *comparators)
+      __create_multitype_datastore__
+
+      # Get the type name if a typeset is passed as an object
+      type = type.type if type.is_a?(Object) && type.respond_to?(:__multitype_typeset__)
+
+      # Append to the list comparator columns
+      __update_multitype_cache__(type, :comparators, comparators)
+    end
+
+    def type_alias(type, *aliases)
+      __create_multitype_datastore__
+
+      # Get the type name if a typeset is passed as an object
+      type = type.type if type.is_a?(Object) && type.respond_to?(:__multitype_typeset__)
+      raise NoTypeError, type.to_s unless __get_multitype_cache__(type)
+
+      aliases.each do |_alias|
+        alias_method _alias, type
+      end
+    end
+
+    def type_accessor(type, *columns)
+      __create_multitype_datastore__
+
+      # Add accessors to the typeset that is passed or any typesets matching type
+      if type.is_a?(Object) && type.respond_to?(:__multitype_typeset__)
+        type.class.__send__(:attr_accessor, *columns)
+      else
+        raise NoTypeError, type.to_s unless __get_multitype_cache__(type)
+        raise NoTypeSetError, type.to_s unless __get_multitype_cache__(type, :typesets)
+        __get_multitype_cache__(type, :typesets).each do |name, typeset|
+          typeset.class.attr_accessor(*columns)
+        end
+      end
+    end
+
+    def deftype(type, name, args = {}, &block)
+      __create_multitype_datastore__
+      type = type.to_sym
+      name = name.to_sym
+
+      # Merge in name, type and model for accessable access
+      args.merge!(type: type, name: name, model: self)
+
+      # Get the list of accessable keys we need
+      accessable = args.keys.map(&:to_sym)
+
+      # Kickstart the type comparators
+      type_comparator(type)
+
+      # Get the name of the class to extend if it exists
+      type_class = if args[:class]
+        klass = if args[:class].is_a?(String)
+          get_const(args[:class])
+        else
+          args[:class]
+        end
+
+        klass.is_a?(Object) ? klass : Object
+      else
+        Object
+      end
+
+      # Define the class and mark as a typeset
+      object = Class.new(type_class)
+      object.class_attribute :__multitype_typeset__
+      object.__multitype_typeset__ = true
+
+      # Execute the passed block as if it was class level code
+      object.class_exec(&block) if block_given?
+
+      # Instantiate the object
+      object = object.new
+
+      # Make the variables passed accessable
+      type_accessor(object, *accessable)
+
+      # Set the instance attributes that were passed in
+      args.each { |key, val| object.__send__("#{key}=", val) }
+
+      # Add the type to the multitype cache
+      __update_multitype_cache__(type, :typesets, {name => object})
+
+      # Create the accessor method if it does not exist
+      unless self.respond_to?(type)
+        self.__send__(:define_method, type) do
+          use_typeset = nil # Object to return
+
+          # Loop through the types to find the one to use
+          __get_multitype_cache__(type, :typesets).each do |name, typeset|
+            match = true # Did we find a match
+
+            # Loop through the type comparators to find a match
+            __get_multitype_cache__(type, :comparators).each do |comparator|
+
+              # Check the comparator for a match
+              match = if typeset.respond_to?(comparator) && self.respond_to?(comparator)
+                typeset.__send__(comparator) == self.__send__(comparator)
+              else
+                false
+              end
+
+              # If we fail at least one
+              # match then break the loop
+              break unless match
+            end
+
+            # If we have a match,
+            # stop looking for one
+            if match
+              use_typeset = typeset
+              break
+            end
+          end
+
+          # Return the typeset
+          use_typeset
+        end
+      end
+
+      object
+    end
+
+    def __get_multitype_cache__(type = nil, cat = nil, klass = self.name.to_sym, depth = 0)
+      type = type.to_sym if type
+      cat  = cat.to_sym  if cat
+
+      # If the klass is not cached just return nil
+      return nil unless __multitype_cache__[klass]
+
+      # Return the level of data requested
+      result = if type.nil? && cat.nil?
+        __multitype_cache__[klass]
+      elsif cat.nil? && __multitype_cache__[klass]
+        __multitype_cache__[klass][type]
+      elsif __multitype_cache__[klass] && __multitype_cache__[klass][type]
+        __multitype_cache__[klass][type][cat]
+      else
+        nil
+      end
+
+      # Don't loop through ancestors on lower objects
+      return result if depth > 0
+
+      # Iterate over ancestors to use their typesets
+      ancestors.inject(result) do |out, ancestor|
+        ancestor = ancestor.name.to_sym
+
+        # Skip if ancestor is self or Multitype
+        if ancestor == klass || ancestor == 'Multitype'
+          out
+        else
+
+          # Get data lower down the ancestry tree
+          merge_in = __get_multitype_cache__(type, cat, ancestor, depth + 1)
+
+          # Merge in data as required
+          if out.nil? && ! merge_in.nil?
+            merge_in
+          else
+            if merge_in.is_a?(Array)
+              out.concat(merge_in)
+            elsif merge_in.is_a?(Hash)
+              out.merge(merge_in)
+            else
+              out
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def __update_multitype_cache__(type, cat, data)
+      klass = self.name.to_sym
+      type  = type.to_sym
+      cat   = cat.to_sym
+
+      # Create the hashes if they don't exist
+      __multitype_cache__[klass] ||= {}
+      __multitype_cache__[klass][type] ||= {}
+      __multitype_cache__[klass][type][cat] ||= data
+
+      # Merge in the data for hashes
+      if data.is_a?(Hash)
+        data = __multitype_cache__[klass][type][cat].merge(data)
+        __multitype_cache__[klass][type][cat] = data
+      end
+
+      # Concatanate the data for arrays
+      if data.is_a?(Array)
+        data = __multitype_cache__[klass][type][cat].concat(data).uniq
+        __multitype_cache__[klass][type][cat] =  data
+      end
+
+      __multitype_cache__[klass]
+    end
+
+    def __create_multitype_datastore__
+      if ! self.respond_to?(:__multitype_cache__)
+        class_attribute :__multitype_cache__
+        self.__send__(:__multitype_cache__=, {})
+        true
+      else
+        false
+      end
+    end
+  end
+end
+

data/multitype.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multitype/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multitype"
+  spec.version       = Multitype::VERSION
+  spec.authors       = ["Kelly Becker"]
+  spec.email         = ["kellylsbkr@gmail.com"]
+  spec.description   = %q{Allows for dynamic methods and data dependent on the data on a classes instance attributes}
+  spec.summary       = %q{Add dynamic methods for ruby classes}
+  spec.homepage      = "http://github.com/JIFFinc/multitype"
+
+  # Determine the proper license for this code
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "awesome_print"
+  spec.add_dependency "activesupport", ">= 3.2.13"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'multitype'
+Dir[File.join(File.dirname(__FILE__), 'support', '*.rb')].each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/a_type_set.rb

@@ -0,0 +1,5 @@
+class ATypeSet
+  def run
+    :works
+  end
+end

data/spec/support/b_type_set.rb

@@ -0,0 +1,2 @@
+class BTypeSet
+end

data/spec/support/fake_model.rb

@@ -0,0 +1,31 @@
+class FakeModel
+  include Multitype
+
+  def initialize(compare = nil)
+    @compare = compare
+  end
+
+  type_comparator :math, :compare
+
+  deftype :math, 'Addition', compare: :addition do
+    def run(num1, num2)
+      num1 + num2
+    end
+  end
+
+  deftype :math, 'Multiplication', compare: :multiplication do
+    def run(num1, num2)
+      num1 * num2
+    end
+
+    def message
+      "Method Exists"
+    end
+  end
+
+  deftype :general, 'APrefined', class: ATypeSet
+  deftype :general, 'BPrefined', class: BTypeSet
+
+  deftype :override, 'Prefined', class: BTypeSet
+  deftype :override, 'Prefined', class: ATypeSet
+end

data/spec/support/fake_model_2.rb

@@ -0,0 +1,10 @@
+class FakeModel2 < FakeModel
+
+  deftype :pizza, 'Pizza' do
+    def run
+      :pizza
+    end
+  end
+
+  type_alias :pizza, :sauce
+end

data/spec/tests/multitype_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe "Test the multitype with FakeModel" do
+  it "Should evaluate 5 + 2 using a type" do
+    result = FakeModel.new(:addition).math.run(5, 2)
+    result.should == 7
+  end
+
+  it "Should evaluate 5 * 2 using a type" do
+    result = FakeModel.new(:multiplication).math.run(5, 2)
+    result.should == 10
+  end
+
+  it "Should not find the method `message`" do
+    expect do
+      FakeModel.new(:addition).math.message()
+    end.to raise_error
+  end
+
+  it "Should find the method `message`" do
+    result = FakeModel.new(:multiplication).math.message()
+    result.should == "Method Exists"
+  end
+
+  it "Should allow use of a predefined class inside the type" do
+    result = FakeModel.new.general.run()
+    result.should == :works
+  end
+
+  it "Should run the first defined typeset if there is no comparator" do
+    result = FakeModel.new.general.run()
+    result.should == :works
+  end
+
+  it "Should override typeset if you redeclare with the same name" do
+    result = FakeModel.new.override.run()
+    result.should == :works
+  end
+end
+
+describe "Test the multitype with FakeModel2 (inherits FakeModel)" do
+  it "Should evaluate 5 + 2 using a type (inherited from FakeModel)" do
+    result = FakeModel2.new(:addition).math.run(5, 2)
+    result.should == 7
+  end
+
+  it "Should evaluate 5 * 2 using a type (inherited from FakeModel)" do
+    result = FakeModel2.new(:multiplication).math.run(5, 2)
+    result.should == 10
+  end
+
+  it "Should define a new type `pizza` on FakeModel2" do
+    result = FakeModel2.new.pizza.run()
+    result.should == :pizza
+  end
+
+  it "Should use alias defined for `pizza`" do
+    result = FakeModel2.new.sauce.run()
+    result.should == :pizza
+  end
+
+  it "Pizza should not exist on FakeModel" do
+    expect do
+      FakeModel.new.pizza.run()
+    end.to raise_error
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: multitype
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kelly Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 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: awesome_print
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+description: Allows for dynamic methods and data dependent on the data on a classes
+  instance attributes
+email:
+- kellylsbkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multitype.rb
+- lib/multitype/version.rb
+- multitype.gemspec
+- spec/spec_helper.rb
+- spec/support/a_type_set.rb
+- spec/support/b_type_set.rb
+- spec/support/fake_model.rb
+- spec/support/fake_model_2.rb
+- spec/tests/multitype_spec.rb
+homepage: http://github.com/JIFFinc/multitype
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Add dynamic methods for ruby classes
+test_files:
+- spec/spec_helper.rb
+- spec/support/a_type_set.rb
+- spec/support/b_type_set.rb
+- spec/support/fake_model.rb
+- spec/support/fake_model_2.rb
+- spec/tests/multitype_spec.rb
+has_rdoc: