enum_records 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'activerecord', '>= 3.0.9'
+  gem 'activesupport', '>= 3.0.9'
+  gem 'sqlite3'
+  gem 'globalize3'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alex Tkachev
+
+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.rdoc

@@ -0,0 +1,19 @@
+= enum_records
+
+Description goes here.
+
+== Contributing to enum_records
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Alex Tkachev. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "enum_records"
+  gem.homepage = "http://github.com/alextk/enum_records"
+  gem.license = "MIT"
+  gem.summary = %Q{Allows to create named model records (enums).}
+  gem.description = %Q{This gem allows to created enum records (named records) and to retrieve them easily. Support globalize3 localization in enum fields initialization. }
+  gem.email = "tkachev.alex@gmail.com"
+  gem.authors = ["Alex Tkachev"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enum_records #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/enum_records.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enum_records}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Tkachev"]
+  s.date = %q{2011-07-24}
+  s.description = %q{This gem allows to created enum records (named records) and to retrieve them easily. Support globalize3 localization in enum fields initialization. }
+  s.email = %q{tkachev.alex@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "enum_records.gemspec",
+    "lib/enum_records.rb",
+    "spec/db/database.yml",
+    "spec/db/schema.rb",
+    "spec/db/schema_loader.rb",
+    "spec/enum_records_spec.rb",
+    "spec/models/article.rb",
+    "spec/models/document.rb",
+    "spec/models/page.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/alextk/enum_records}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Allows to create named model records (enums).}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 3.0.9"])
+      s.add_development_dependency(%q<activesupport>, [">= 3.0.9"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<globalize3>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.9"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.9"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<globalize3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.9"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.9"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<globalize3>, [">= 0"])
+  end
+end
+

data/lib/enum_records.rb

@@ -0,0 +1,105 @@
+module EnumRecords
+
+  module ActiveRecord
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+
+      def acts_as_enum(enum_column_name = 'enum_key')
+        self.class_eval do
+          # first cehck for enum column name existance
+          raise ArgumentError, "Enum column #{enum_column_name} doesn't exsist in the table" unless self.columns_hash.keys.include?(enum_column_name)
+
+          # stores all the names for named records (and their optoins) that are defined in the model.
+          self.class_attribute :_enums
+          self._enums = {
+            :definitions => {},
+            :column_name => enum_column_name
+          }
+
+          #define class methods
+          def self.define_enums *args, &block
+            self._enums[:globalized] = self.respond_to?(:translations_table_name)
+            EnumRecords::Definer.new self, &block
+          end
+
+          def self.enums
+            self.where(self._enums[:column_name].to_sym => self._enums[:definitions].keys)
+          end
+
+          def self.enum(key)
+            self.send "find_by_#{self._enums[:column_name]}", key
+          end
+
+        end
+      end
+    end
+
+    module InstanceMethods
+
+    end
+
+  end
+
+  # use the Enumeration class capture enum names as methods or contants
+  class Definer
+    def initialize model_class, &block
+      @model_class = model_class
+      EnumNameCapturer.new(self, &block)
+    end
+
+    def add_new_enum(method_sym, options)
+      # Check that the model's translation table exist if locales are passed so that in migration we will not have an exception
+      return if @model_class._enums[:globalized] && !options[:locales].blank? && !@model_class.connection.table_exists?(@model_class.translations_table_name)
+
+      enum_name = method_sym.to_s
+      @model_class._enums[:definitions][enum_name] = options
+
+      # Reject options that aren't real data base fields.
+      fields = options.reject { |k, v| !@model_class.columns_hash.keys.include?(k.to_s) }
+
+      localized_fields = options[:locales] || {}
+      
+      # Create or find the record associated with the enum.
+      if !localized_fields.blank? # In case locales hash is passed
+        # Reject options that aren't real data base fields for localized fields.
+        for locale in localized_fields.keys
+          localized_fields[locale] = localized_fields[locale].reject { |k, v| !@model_class.columns_hash.keys.include?(k.to_s) }
+        end
+        if @model_class.enum(enum_name).nil? #enum hasn't been created yet
+          record = find_or_create_enum_record(enum_name, fields)
+          localized_fields.each_pair do |locale, l_fields|
+            Globalize.with_locale locale do
+              record.update_attributes(l_fields)
+            end
+          end
+        end
+      else # no localization needed => create or find the record associated with the enum.
+        find_or_create_enum_record(enum_name, fields)
+      end
+    end
+
+    def find_or_create_enum_record(enum_name, fields)
+      @model_class.send "find_or_create_by_#{@model_class._enums[:column_name]}", enum_name, fields
+    end
+  end
+
+  class EnumNameCapturer
+    def initialize definer, &block
+      @definer = definer
+      instance_eval(&block)
+    end
+
+    def method_missing method_sym, *args, &block
+      @definer.add_new_enum method_sym, args[0]
+    end
+  end
+
+end
+
+
+ActiveRecord::Base.send :include, EnumRecords::ActiveRecord

data/spec/db/database.yml

@@ -0,0 +1,9 @@
+# vendor/plugins/acts_as_enum/test/database.yml
+
+sqlite:
+  adapter: sqlite
+  database: ":memory:"
+
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/db/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :articles, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :documents, :force => true do |t|
+    t.string :name
+    t.string :enum_key
+    t.timestamps
+  end
+
+  create_table :pages do |t|
+    t.string :title, :enum_key
+    t.text :intro
+    t.boolean :published
+    t.integer :position
+    t.timestamps
+  end
+
+end
+
+require File.join(File.dirname(__FILE__), '..', 'models', 'page')
+Page.create_translation_table! :title => :string, :intro => :text

data/spec/db/schema_loader.rb

@@ -0,0 +1,11 @@
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = 'sqlite3'
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+
+load_schema

data/spec/enum_records_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActiveRecord::Base" do
+  it "should respond to :define_enums" do
+    ActiveRecord::Base.respond_to?(:acts_as_enum).should be_true
+  end
+end
+
+describe "Article" do
+  it "should not act_as_enum" do
+    Article.should_not respond_to :define_enums
+    Article.should_not respond_to :enums
+    Article.should_not respond_to :enum
+  end
+
+  it "should check for enum column existance" do
+    lambda { Article.acts_as_enum }.should raise_error
+  end
+end
+
+describe "Document" do
+
+  before(:all) do
+    @non_enum = Document.create(:name => 'not enum')
+  end
+
+  it "should act_as_enum" do
+    Document.should respond_to :define_enums
+    Document.should respond_to :enums
+    Document.should respond_to :enum
+    Document._enums[:column_name].should == 'enum_key'
+  end
+
+  it 'should find defined "home" enum' do
+    enum_doc = Document.enum(:home)
+    enum_doc.should_not be_nil
+    enum_doc.name.should == 'Home page'
+    enum_doc.should == Document.enum('home')
+  end
+
+  it 'should not recreate defined enum' do
+    enum_doc = Document.enum(:home)
+    enum_doc.id.should == Document.enum(:home).id
+    enum_doc.id.should == enum_doc.id.should
+  end
+
+  it 'should find defined "about" enum' do
+    enum_doc = Document.enum(:about)
+    enum_doc.should_not be_nil
+    enum_doc.name.should == 'About page'
+  end
+
+  it 'should find defined "contact_form" enum' do
+    enum_doc = Document.enum(:contact_form)
+    enum_doc.should_not be_nil
+    enum_doc.name.should == 'Contact us'
+  end
+
+  it 'should not find "foo" enum' do
+    enum_doc = Document.enum(:foo)
+    enum_doc.should be_nil
+  end
+
+  it 'should find 3 defined enums' do
+    enums = Document.enums
+    enums.length.should == 3
+    Document.count.should == 4
+    enums.should include(Document.enum(:home), Document.enum(:about), Document.enum(:contact_form))
+    enums.should_not include(@non_enum)
+  end
+
+end
+
+describe "Page" do
+  before(:all) do
+    @non_enum = Page.create(:title => 'not enum')
+  end
+
+  it 'should find 3 defined enums' do
+    enums = Page.enums
+    enums.length.should == 3
+    Page.count.should == 4
+    enums.should include(Page.enum(:home), Page.enum(:profile), Page.enum(:project_categories))
+    enums.should_not include(@non_enum)
+  end
+
+  context 'should have localized enums fields' do
+
+    it 'when locale is en-US' do
+      I18n.locale = :'en-US'
+      I18n.locale.should == :'en-US'
+      Page.enum(:home).title.should == 'Home'
+      Page.enum(:profile).title.should == 'Profile'
+      Page.enum(:project_categories).title.should == 'Projects'
+    end
+
+    it 'when locale is he-IL' do
+      I18n.locale = :'he-IL'
+      I18n.locale.should == :'he-IL'
+      Page.enum(:home).title.should == 'דף הבית'
+      Page.enum(:profile).title.should == 'פרופיל'
+      Page.enum(:project_categories).title.should == 'פרויקטים'
+    end
+
+  end
+
+end

data/spec/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+
+end

data/spec/models/document.rb

@@ -0,0 +1,12 @@
+class Document < ActiveRecord::Base
+  acts_as_enum
+  
+  define_enums do
+    home :name => 'Home page'
+    about :name => 'About page'
+    contact_form :name => 'Contact us'
+  end
+
+  #define 'Home', :name=>"home page"
+  #define :About, :name=>"about page", :link_to => 'google'
+end

data/spec/models/page.rb

@@ -0,0 +1,11 @@
+class Page < ActiveRecord::Base
+  acts_as_enum
+
+  translates :title, :intro
+
+  define_enums do
+    home :position=>1, :published => true, :locales => {'en-US'=>{:title=>'Home'}, 'he-IL'=>{:title=>'דף הבית'}}
+    profile :position=>2, :published => true, :locales=>{'en-US'=>{:title=>'Profile'}, 'he-IL'=>{:title=>'פרופיל'}}
+    project_categories :position=>3, :published=>true, :locales=>{'en-US'=>{:title=>'Projects'}, 'he-IL'=>{:title=>'פרויקטים'}}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+require 'logger'
+require 'active_record'
+require 'active_support'
+require 'sqlite3'
+require 'globalize3'
+
+require 'enum_records'
+
+#load models schema (create tables)
+require "db/schema_loader"
+
+#load models
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'models'))
+Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each {|f| require f}
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification 
+name: enum_records
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Tkachev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-24 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 0
+        - 9
+        version: 3.0.9
+  type: :development
+  name: activerecord
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 0
+        - 9
+        version: 3.0.9
+  type: :development
+  name: activesupport
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: sqlite3
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: globalize3
+  version_requirements: *id008
+description: "This gem allows to created enum records (named records) and to retrieve them easily. Support globalize3 localization in enum fields initialization. "
+email: tkachev.alex@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- enum_records.gemspec
+- lib/enum_records.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/schema_loader.rb
+- spec/enum_records_spec.rb
+- spec/models/article.rb
+- spec/models/document.rb
+- spec/models/page.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/alextk/enum_records
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Allows to create named model records (enums).
+test_files: []
+