mastar 0.9.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 pinzolo
+
+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,29 @@
+# Mastar
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mastar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-cfs']
+  end
+rescue LoadError => e
+end

data/lib/mastar.rb

@@ -0,0 +1,100 @@
+# coding: utf-8
+require 'mastar/version'
+require 'mastar/configuration'
+require 'mastar/name_value_pair'
+
+module Mastar
+  def self.included(base)
+    class << base
+      alias_method :find!, :find
+    end
+    base.extend(ClassMethods)
+    base.__send__(:include, InstanceMethods)
+    base.__send__(:before_save, :remove_record_cache)
+  end
+
+  module ClassMethods
+    def pairs(options = {})
+      opts = safe_options(options)
+      name = extract_option_value(opts, :name, mastar_config.name)
+      value = extract_option_value(opts, :value, mastar_config.value)
+      self.select([name, value]).map { |r| NameValuePair.new(r.__send__(name), r.__send__(value)) }
+    end
+
+    def find(id)
+      mastar_records[id] ||= find!(id)
+      mastar_records[id]
+    end
+
+    private
+    def mastar(options = {})
+      opts = safe_options(options)
+      unless opts.empty?
+        mastar_config.name(extract_option_value(opts, :name))
+        mastar_config.value(extract_option_value(opts, :value))
+        mastar_config.key(extract_option_value(opts, :key))
+      end
+      mastar_config
+    end
+
+    def mastar_config
+      @mastar_config ||= Mastar::Configuration.new
+    end
+
+    def mastar_records
+      @mastar_records ||= {}
+    end
+
+    def safe_options(options)
+      options.is_a?(Hash) ? options : {}
+    end
+
+    def extract_option_value(options, key, default_value = nil)
+      val = options[key] || options[key.to_s]
+      val = val || default_value if default_value
+      val.to_sym
+    end
+
+    def method_missing(name, *args)
+      if mastar_config.key
+        define_direct_method(name)
+        respond_to?(name) ? __send__(name, *args) : nil
+      else
+        super
+      end
+    end
+
+    def define_direct_method(name)
+      rec = where(mastar_config.key => name.to_s).first
+      return unless rec
+
+      mastar_records[rec.id] = rec
+      klass = class << self; self end
+      klass.class_eval do
+        eval("instance_variable_set('@#{name}_id', #{rec.id})")
+        define_method(name) do |*args|
+          record_id = klass.instance_variable_get("@#{name}_id")
+          mastar_records[record_id] ||= find(record_id)
+          record = mastar_records[record_id]
+          if args.nil? || args.empty? || record.nil?
+            record
+          elsif args.length == 1
+            record.__send__(args.first)
+          else
+            args.map { |arg| record.__send__(arg) }
+          end
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    private
+    def remove_record_cache
+      if self.id
+        records = self.class.__send__('mastar_records')
+        records[self.id] = nil
+      end
+    end
+  end
+end

data/lib/mastar/configuration.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+module Mastar
+  class Configuration
+    def initialize(options = {})
+      opts = options.is_a?(Hash) ? options : {}
+      [:name, :value, :key].each do |k|
+        v = opts[k] || opts[k.to_s]
+        __send__(k, v.to_sym) if v
+      end
+    end
+
+    def name(name = nil)
+      @name = name if name
+      @name || :name
+    end
+
+    def value(value = nil)
+      @value = value if value
+      @value || :id
+    end
+
+    def key(key = nil)
+      @key = key if key
+      @key
+    end
+  end
+end

data/lib/mastar/name_value_pair.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+module Mastar
+  class NameValuePair
+    attr_accessor :name, :value
+    alias_method :first, :name
+    alias_method :last, :value
+
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+  end
+end

data/lib/mastar/version.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+module Mastar
+  VERSION = "0.9.0"
+end

data/mastar.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mastar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["pinzolo"]
+  gem.email         = ["pinzolo@gmail.com"]
+  gem.description   = %q{MASTer table on Active Record}
+  gem.summary       = %q{add some features to master table class on ActiveRecord}
+  gem.homepage      = "https://github.com/pinzolo/mastar"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mastar"
+  gem.require_paths = ["lib"]
+  gem.version       = Mastar::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'activerecord'
+end

data/spec/fixtures/dows.yml

@@ -0,0 +1,35 @@
+sunday:
+  id: 1
+  name: sunday
+  short_name: Sun.
+  holiday: true
+monday:
+  id: 2
+  name: monday
+  short_name: Mon.
+  holiday: false
+tuesday:
+  id: 3
+  name: tuesday
+  short_name: Tue.
+  holiday: false
+wednesday:
+  id: 4
+  name: wednesday
+  short_name: Wed.
+  holiday: false
+thursday:
+  id: 5
+  name: thursday
+  short_name: Thu.
+  holiday: false
+friday:
+  id: 6
+  name: friday
+  short_name: Fri.
+  holiday: false
+saturday:
+  id: 7
+  name: saturday
+  short_name: Sat.
+  holiday: true

data/spec/mastar/configuration_spec.rb

@@ -0,0 +1,111 @@
+# coding: utf-8
+require 'spec_helper'
+describe Mastar::Configuration do
+  context 'initialized without parameter' do# {{{
+    before do
+      @config = Mastar::Configuration.new
+    end
+    describe '#name' do
+      it 'is :name' do
+        @config.name.should be :name
+      end
+    end
+    describe '#value' do
+      it 'is :id' do
+        @config.value.should be :id
+      end
+    end
+    describe '#key' do
+      it 'is nil' do
+        @config.key.should be nil
+      end
+    end
+  end# }}}
+
+  context 'initialized with Hash parameters (name: title, value: value, key: uid)' do
+    context 'key: symbol, value: symbol' do# {{{
+      before do
+        @config = Mastar::Configuration.new(:name => :title, :value => :value, :key => :uid)
+      end
+      describe '#name' do
+        it 'is :title' do
+          puts @config.name
+          @config.name.should be :title
+        end
+      end
+      describe '#value' do
+        it 'is :value' do
+          @config.value.should be :value
+        end
+      end
+      describe '#key' do
+        it 'is :uid' do
+          @config.key.should be :uid
+        end
+      end
+    end# }}}
+
+    context 'key: symbol, value: string' do# {{{
+      before do
+        @config = Mastar::Configuration.new(:name => 'title', :value => 'value', :key => 'uid')
+      end
+      describe '#name' do
+        it 'is :title' do
+          @config.name.should be :title
+        end
+      end
+      describe '#value' do
+        it 'is :value' do
+          @config.value.should be :value
+        end
+      end
+      describe '#key' do
+        it 'is :uid' do
+          @config.key.should be :uid
+        end
+      end
+    end# }}}
+
+    context 'key: string, value: string' do# {{{
+      before do
+        @config = Mastar::Configuration.new('name' => 'title', 'value' => 'value', 'key' => 'uid')
+      end
+      describe '#name' do
+        it 'is :title' do
+          @config.name.should be :title
+        end
+      end
+      describe '#value' do
+        it 'is :value' do
+          @config.value.should be :value
+        end
+      end
+      describe '#key' do
+        it 'is :uid' do
+          @config.key.should be :uid
+        end
+      end
+    end# }}}
+  end
+
+  context 'initialized with parameters (not Hash)' do# {{{
+    before do
+      @config = Mastar::Configuration.new(['title', 'value', 'uid'])
+    end
+    describe '#name' do
+      it 'is :name' do
+        @config.name.should be :name
+      end
+    end
+    describe '#value' do
+      it 'is :id' do
+        @config.value.should be :id
+      end
+    end
+    describe '#key' do
+      it 'is nil' do
+        @config.key.should be nil
+      end
+    end
+  end# }}}
+end

data/spec/mastar/name_value_pair_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+require 'spec_helper'
+describe Mastar::NameValuePair do
+  context 'initialized with name and value' do
+    before do
+      @pair = Mastar::NameValuePair.new('label', 1)
+    end
+    describe '#name' do
+      it 'is label' do
+        @pair.name.should eq 'label'
+      end
+    end
+    describe '#value' do
+      it 'is 1' do
+        @pair.value.should eq 1
+      end
+    end
+    describe '#first' do
+      it 'is equal #name' do
+        @pair.first.should eq @pair.name
+      end
+    end
+    describe '#last' do
+      it 'is equal #value' do
+        @pair.last.should eq @pair.last
+      end
+    end
+  end
+end

data/spec/mastar_spec.rb

@@ -0,0 +1,195 @@
+# coding: utf-8
+require 'spec_helper'
+def pair_map(pairs)
+  pairs.inject({}) do |result, item|
+    result[item.value] = item.name
+    result
+  end
+end
+
+describe Mastar do
+  describe Mastar::ClassMethods do
+    describe '.pairs' do
+      context 'default' do
+        context 'directly called' do
+          before do
+            @all_dows = Dow1.all
+          end
+          it 'defined' do
+            defined?(Dow1.pairs).should be_true
+          end
+          context 'without option argument' do
+            it 'respond to :first' do
+              Dow1.pairs.all? { |pair| pair.respond_to?(:first) }.should be_true
+            end
+            it 'respond to :last' do
+              Dow1.pairs.all? { |pair| pair.respond_to?(:last) }.should be_true
+            end
+            it 'get all rows' do
+              pairs = pair_map(Dow1.pairs)
+              @all_dows.all? { |dow| pairs[dow.id] == dow.name }.should be_true
+            end
+          end
+          context 'with option argument(:name => :short_name, :value => :name)' do# {{{
+            context 'key: Symbol, value: Symbol' do
+              it 'get specified columns by option' do
+                pairs = pair_map(Dow1.pairs(:name => :short_name, :value => :name))
+                @all_dows.all? { |dow| pairs[dow.name] == dow.short_name }.should be_true
+              end
+            end
+            context 'key: String, value: Symbol' do
+              it 'same as above' do
+                pairs = pair_map(Dow1.pairs('name' => :short_name, 'value' => :name))
+                @all_dows.all? { |dow| pairs[dow.name] == dow.short_name }.should be_true
+              end
+            end
+            context 'key: Symbol, value: String' do
+              it 'same as above' do
+                pairs = pair_map(Dow1.pairs(:name => 'short_name', :value => 'name'))
+                @all_dows.all? { |dow| pairs[dow.name] == dow.short_name }.should be_true
+              end
+            end
+            context 'key: String, value: String' do
+              it 'same as above' do
+                pairs = pair_map(Dow1.pairs('name' => 'short_name', 'value' => 'name'))
+                @all_dows.all? { |dow| pairs[dow.name] == dow.short_name }.should be_true
+              end
+            end
+          end# }}}
+          context 'with nil argument' do
+            it 'same as no option' do
+              pairs = pair_map(Dow1.pairs)
+              @all_dows.all? { |dow| pairs[dow.id] == dow.name }.should be_true
+            end
+          end
+        end
+        context 'called by way of ARel' do
+          it 'respond' do
+            Dow1.holiday.respond_to?(:pairs).should be_true
+          end
+          it 'get filtered rows' do
+            pairs = pair_map(Dow1.holiday.pairs)
+            Dow1.where(:holiday => true).all? { |dow| pairs[dow.id] == dow.name }.should be_true
+          end
+        end
+      end
+      context 'use mastar_name method' do
+        it 'use mastar_name attr as name' do
+          pairs = pair_map(Dow3.pairs)
+          Dow3.all.all? { |dow| pairs[dow.id] == dow.short_name }.should be_true
+        end
+      end
+      context 'use mastar_value method' do
+        it 'use mastar_value attr as value' do
+          pairs = pair_map(Dow2.pairs)
+          Dow2.all.all? { |dow| pairs[dow.short_name] == dow.name }.should be_true
+        end
+      end
+    end
+    describe 'define direct class method' do
+      context 'no argument' do
+        it 'get record object' do
+          Dow1.respond_to?(:sunday).should be_false
+          Dow1.sunday.is_a?(Dow1).should be_true
+          Dow1.respond_to?(:sunday).should be_true
+          Dow1.sunday.name.should eq 'sunday'
+        end
+      end
+      context 'with 1 argument' do
+        it 'get attribute value at direct' do
+          Dow1.monday(:short_name).should eq 'Mon.'
+        end
+      end
+      context 'with multiple arguments' do
+        it 'get Array of attribute values at a time' do
+          Dow1.tuesday(:short_name, :holiday).is_a?(Array).should be_true
+          short_name, name = Dow1.wednesday(:short_name, :name)
+          short_name.should eq 'Wed.'
+          name.should eq 'wednesday'
+        end
+      end
+      context 'mastar.key is not set' do
+        it 'raise NoMethodError' do
+          lambda { Dow2.monday }.should raise_error(NoMethodError)
+        end
+      end
+    end
+    describe 'not exist in key column' do
+      context 'no argument' do
+        it 'get nil' do
+          Dow1.foo.should be_nil
+        end
+      end
+      context 'with 1 argument' do
+        it 'get nil' do
+          Dow1.bar(:name).should be_nil
+        end
+      end
+      context 'with multiple arguments' do
+        it 'get nil' do
+          Dow1.baz(:name, :value).should be_nil
+        end
+      end
+    end
+    describe '.mastar multiple setting' do
+      context 'mastar#name, mastar#value' do
+        it '.pairs method works' do
+          pairs = pair_map(Dow4.pairs)
+          Dow4.all.all? { |dow| pairs[dow.name] == dow.short_name }.should be_true
+        end
+      end
+      context 'mastar#key' do
+        it 'direct class method defining works' do
+          Dow4.respond_to?(:sunday).should be_false
+          Dow4.sunday.is_a?(Dow4).should be_true
+          Dow4.respond_to?(:sunday).should be_true
+          Dow4.sunday.name.should eq 'sunday'
+        end
+      end
+    end
+    describe '.find' do
+      context 'called by cached id' do
+        it 'get cached record' do
+          rec = Dow4.wednesday
+          rec.respond_to?(:iii).should be_false
+          class << rec
+            def iii
+              'iii'
+            end
+          end
+          Dow4.find(4).respond_to?(:iii).should be_true
+        end
+      end
+      context 'called by uncached id' do
+        it 'get new record and cache' do
+          recs = Dow4.__send__(:mastar_records)
+          recs[5].should be_nil
+          Dow4.find(5)
+          recs = Dow4.__send__(:mastar_records)
+          recs[5].should_not be_nil
+        end
+      end
+    end
+    describe '.find!' do
+      it 'defined' do
+        Dow2.respond_to?(:find!).should be_true
+      end
+      context 'called' do
+        it 'get record' do
+          Dow2.find(4).id.should eq 4
+        end
+      end
+    end
+  end
+  describe Mastar::InstanceMethods do
+    context 'record update' do
+      it 'direct method record is updated automatically' do
+        Dow1.friday.holiday?.should eq false
+        fri = Dow1.find(Dow1.friday.id)
+        fri.holiday = true
+        fri.save
+        Dow1.friday.holiday?.should eq true
+      end
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+class Dow1 < ActiveRecord::Base
+  include Mastar
+  scope :holiday, lambda { where(:holiday => true) }
+  mastar.key :name
+
+end
+
+class Dow2 < ActiveRecord::Base
+  include Mastar
+  mastar.value :short_name
+
+end
+
+class Dow3 < ActiveRecord::Base
+  include Mastar
+  mastar.name :short_name
+
+end
+
+class Dow4 < ActiveRecord::Base
+  include Mastar
+  mastar :name => :short_name, :value => :name, :key => :name
+end

data/spec/schema.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+ActiveRecord::Schema.define :version => 0 do
+  (1..4).to_a.each do |i|
+    create_table "dow#{i}s", :force => true do |t|
+      t.string :name
+      t.string :short_name
+      t.boolean :holiday
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+base_dir = File.dirname(__FILE__)
+$:.unshift(base_dir, '/../lib')
+require 'mastar'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Base.silence do
+  load(base_dir + '/schema.rb')
+  load(base_dir + '/models.rb')
+end
+
+require 'yaml'
+(1..4).to_a.each do |i|
+  yml = YAML.load_file("#{base_dir}/fixtures/dows.yml")
+  yml.keys.each do |k|
+    eval("Dow#{i}.create(yml[k])")
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mastar
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- pinzolo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MASTer table on Active Record
+email:
+- pinzolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mastar.rb
+- lib/mastar/configuration.rb
+- lib/mastar/name_value_pair.rb
+- lib/mastar/version.rb
+- mastar.gemspec
+- spec/fixtures/dows.yml
+- spec/mastar/configuration_spec.rb
+- spec/mastar/name_value_pair_spec.rb
+- spec/mastar_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pinzolo/mastar
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: add some features to master table class on ActiveRecord
+test_files:
+- spec/fixtures/dows.yml
+- spec/mastar/configuration_spec.rb
+- spec/mastar/name_value_pair_spec.rb
+- spec/mastar_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb