master_cache 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format s

data/.travis.yml

@@ -0,0 +1,8 @@
+services:
+  - sqlite3
+
+script: 'bundle exec rake spec'
+
+rvm:
+  - 1.8.7
+  - 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format s', :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 DianthuDia
+
+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,80 @@
+# MasterCache
+
+[![Build Status](https://secure.travis-ci.org/DianthuDia/master_cache.png)](http://travis-ci.org/DianthuDia/master_cache) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/DianthuDia/master_cache)
+
+A master record cache plugin
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'master_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install master_cache
+
+## Usage
+
+### Basics
+
+```ruby
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:employee_types) {|t| t.string :name; t.integer :position}
+  end
+end
+
+class EmployeeType
+  master_cache # :const_name => :name, :order_name => :position, :all_name => 'INSTANCES'
+end
+
+EmployeeType.create :name => 'STAFF', :position => 1 
+EmployeeType.create :name => 'EMPLOYEE', :position => 2 
+```
+
+```ruby
+EmployeeType::STAFF.id # => 1
+EmployeeType::EMPLOYEE.id # => 2
+
+EmployeeType.find(1).staff? # => true
+EmployeeType.find(2).staff? # => false
+
+EmployeeType::INSTANCES # => [EmployeeType::STAFF, EmployeeType::EMPLOYEE]
+```
+
+### General configuration options
+
+You can configure the following default values by overriding these values using `MasterCache.configure` method.
+
+```ruby
+all_name		# 'INSTANCES' by default
+const_name	# :name by default
+order_name    # :position by default
+```
+
+There's a handy generator that generates the default configuration file into config/initializers directory.
+Run the following generator command, then edit the generated file.
+
+`$ rails g master_cache:config`
+
+## Supported versions
+
+* Ruby 1.8.7, 1.9.3
+* ActiveRecord 3.x
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT License. Copyright 2012 DianthuDia.

data/Rakefile

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

data/lib/generators/master_cache/config_generator.rb

@@ -0,0 +1,14 @@
+module MasterCache::Generators
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+    desc <<DESC
+Description:
+  Copies master_cache configuration file to your application's initializer directory.
+DESC
+
+    def copy_config_file
+      template 'master_cache_config.rb', 'config/initializers/master_cache_config.rb'
+    end
+  end
+end

data/lib/generators/master_cache/templates/master_cache_config.rb

@@ -0,0 +1,5 @@
+MasterCache.configure do |config|
+  # config.all_name = 'INSTANCES'
+  # config.const_name = :name
+  # config.order_name = :position
+end

data/lib/master_cache.rb

@@ -0,0 +1,10 @@
+require "master_cache/version"
+require 'master_cache/config'
+
+require 'active_record'
+
+ActiveSupport.on_load(:active_record) do
+  require 'master_cache/model_extension'
+  ::ActiveRecord::Base.send :include, MasterCache::ModelExtension
+end
+

data/lib/master_cache/config.rb

@@ -0,0 +1,41 @@
+require 'active_support/configurable'
+
+module MasterCache
+  # Configures global settings for MasterCache
+  #   MasterCache.configure do |config|
+  #     config.all_name = :instances
+  #   end
+  def self.configure(&block)
+    yield @config ||= MasterCache::Configuration.new
+  end
+
+  # Global settings for MasterCache
+  def self.config
+    @config
+  end
+
+  # need a Class for 3.0
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :all_name
+    config_accessor :const_name
+    config_accessor :order_name
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  # default
+  configure do |config|
+    config.all_name = 'INSTANCES'
+    config.const_name = :name
+    config.order_name = :position
+  end
+end
+

data/lib/master_cache/model_extension.rb

@@ -0,0 +1,36 @@
+module MasterCache::ModelExtension
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # MasterModel should be called (optional arguments):
+    #
+    #   master_cache(:const_name => :name, :order_name => :position, :all_name => 'INSTANCES')
+    #
+    # const_name: const name
+    # order_name: 'order' name
+    # all_name: cached all instance name
+    def master_cache(options = {})
+      MasterCache.config.tap do |c|
+        options.reverse_merge! :const_name => c.const_name, :order_name => c.order_name, :all_name => c.all_name
+      end
+
+      return if const_defined?(options[:all_name]) && const_get(options[:all_name]).present?
+
+      # default order
+      default_scope order: options[:order_name]
+
+      # Constantize all instances
+      _all = all rescue [] # return [] this before migration
+      const_set options[:all_name], _all
+
+      # Constantize each instance
+      _all.each do |instance|
+        const_name = instance.send(options[:const_name]).to_s.upcase
+        next if const_name.empty? || const_defined?(const_name)
+
+        const_set const_name, instance
+        send :define_method, "#{const_name.downcase}?" do; self === instance end
+      end
+    end
+  end
+end

data/lib/master_cache/version.rb

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

data/master_cache.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'master_cache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "master_cache"
+  gem.version       = MasterCache::VERSION
+  gem.authors       = ["DianthuDia"]
+  gem.email         = ["dianthudia@y7mail.com"]
+  gem.description   = "A master record cache plugin"
+  gem.summary       = "master_cache provides 'master record' cache and easy access these"
+  gem.homepage      = "https://github.com/DianthuDia/master_cache"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord', '>= 3.0.0'
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'rb-fsevent' if RUBY_PLATFORM.include? 'darwin'
+  gem.add_development_dependency 'rb-inotify' if RUBY_PLATFORM.include? 'linux'
+  gem.add_development_dependency 'guard-bundler'
+  gem.add_development_dependency 'guard-rspec'
+end

data/spec/master_cache/config_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe MasterCache::Configuration do
+  shared_examples_for 'a configure object' do
+    context 'by default' do
+      it { should eq default }
+    end
+
+    context 'configured via config block' do
+      before do
+        MasterCache.configure {|c| c.send "#{config_name}=", other}
+      end
+
+      it { should eq other }
+
+      after do
+        MasterCache.configure {|c| c.send "#{config_name}=", default}
+      end
+    end
+  end
+
+  describe '#all_name' do
+    subject { MasterCache.config.all_name }
+    let(:config_name) { :all_name }
+    let(:default) { 'INSTANCES' }
+    let(:other) { 'ALL_DATA' }
+    it_behaves_like 'a configure object'
+  end
+  
+  describe '#const_name' do
+    subject { MasterCache.config.const_name }
+    let(:config_name) { :const_name }
+    let(:default) { :name }
+    let(:other) { :master_name }
+    it_behaves_like 'a configure object'
+  end
+  
+  describe '#order_name' do
+    subject { MasterCache.config.order_name }
+    let(:config_name) { :order_name }
+    let(:default) { :position }
+    let(:other) { :sort_order }
+    it_behaves_like 'a configure object'
+  end
+end
+

data/spec/master_cache/model_extension_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+# migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:test_types) {|t| t.string :name; t.integer :position; t.string :master_name; t.integer :sort_order}
+  end
+end
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up
+
+describe MasterCache::ModelExtension do
+  before { class TestType < ActiveRecord::Base; end }
+ # after { TestType.delete_all }
+  after { Object.send :remove_const, :TestType }
+
+  describe '.master_cache' do
+    context 'called' do
+      before { class TestType < ActiveRecord::Base; master_cache end }
+      before { class TestUser < ActiveRecord::Base; end }
+      after { Object.send :remove_const, :TestUser }
+
+      it { TestType.should be_const_defined 'INSTANCES' }
+      it { TestUser.should_not be_const_defined 'INSTANCES' }
+    end
+    
+    context 'no call' do
+      it { TestType.should_not be_const_defined 'INSTANCES' }
+    end
+  end
+
+  describe "'all_name' option" do
+    context 'no set' do
+      before { class TestType < ActiveRecord::Base; master_cache end }
+      it { TestType.should be_const_defined 'INSTANCES' }
+    end
+    
+    context "set 'ALL_DATA'" do
+      before { class TestType < ActiveRecord::Base; master_cache :all_name => 'ALL_DATA' end }
+      it { TestType.should be_const_defined 'ALL_DATA' }
+    end
+  end
+  
+  describe "'const_name' option" do
+    context 'no set' do
+      before { TestType.create :name => 'APPLE'}
+      before { class TestType < ActiveRecord::Base; master_cache end }
+      it { TestType.should be_const_defined 'APPLE' }
+      it { TestType.should be_method_defined 'apple?' }
+    end
+    
+    context 'set :master_name' do
+      context "a record don't have :master_name" do
+        before { TestType.create :name => 'APPLE'}
+        before { class TestType < ActiveRecord::Base; master_cache :const_name => :master_name end }
+        it { TestType.should_not be_const_defined 'APPLE' }
+        it { TestType.should_not be_method_defined 'apple?' }
+      end
+
+      context "a record have :master_name" do
+        before { TestType.create :master_name => 'APPLE'}
+        before { class TestType < ActiveRecord::Base; master_cache :const_name => :master_name end }
+        it { TestType.should be_const_defined 'APPLE' }
+        it { TestType.should be_method_defined 'apple?' }
+      end
+    end
+  end
+  
+  describe "'order_name' option" do
+    context 'no set' do
+      before { 3.downto(1){|i| TestType.create :position => i} }
+      before { class TestType < ActiveRecord::Base; master_cache end }
+      it { TestType.all.first.position.should be 1}
+    end
+    
+    context 'set :sort_order' do
+      context "a record don't have :sort_order" do
+        before { 3.downto(1){|i| TestType.create :position => i} }
+        before { class TestType < ActiveRecord::Base; master_cache :order_name => :sort_order end }
+        subject { TestType.all.first }
+        its(:position) { should_not be 1}
+        its(:sort_order) { should_not be 1}
+      end
+      
+      context "a record have :sort_order" do
+        before { 3.downto(1){|i| TestType.create :sort_order => i} }
+        before { class TestType < ActiveRecord::Base; master_cache :order_name => :sort_order end }
+        subject { TestType.all.first }
+        its(:position) { should_not be 1}
+        its(:sort_order) { should be 1}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+require 'rubygems'
+require 'master_cache'
+
+# connection
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+require 'database_cleaner'
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+  config.before(:each){ DatabaseCleaner.start }
+  config.after(:each){ DatabaseCleaner.clean }
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: master_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- DianthuDia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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: database_cleaner
+  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: guard
+  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: rb-fsevent
+  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: guard-bundler
+  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: guard-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'
+description: A master record cache plugin
+email:
+- dianthudia@y7mail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/master_cache/config_generator.rb
+- lib/generators/master_cache/templates/master_cache_config.rb
+- lib/master_cache.rb
+- lib/master_cache/config.rb
+- lib/master_cache/model_extension.rb
+- lib/master_cache/version.rb
+- master_cache.gemspec
+- spec/master_cache/config_spec.rb
+- spec/master_cache/model_extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DianthuDia/master_cache
+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'
+      segments:
+      - 0
+      hash: 2184575510681391349
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2184575510681391349
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: master_cache provides 'master record' cache and easy access these
+test_files:
+- spec/master_cache/config_spec.rb
+- spec/master_cache/model_extension_spec.rb
+- spec/spec_helper.rb