enum_records 0.1.0 → 0.1.1

data/Gemfile

@@ -6,6 +6,7 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rdoc"
   gem "rspec", "~> 2.3.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"

data/{README.rdoc → README.md}

@@ -1,8 +1,13 @@
-= enum_records
+# enum_records
 
 Description goes here.
 
-== Contributing to enum_records
+# Versions history
+
+* 0.1.1 - added model instnace accessor method `enum_attributes` to access all fields that were passed at enum definition.
+* 0.1.0 - first release
+
+# 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
@@ -12,7 +17,7 @@ Description goes here.
 * 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
 
 Copyright (c) 2011 Alex Tkachev. See LICENSE.txt for
 further details.

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   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.description = %Q{This gem allows to create enum records (named records) and to retrieve them easily. Supports globalize3 localization in enum fields initialization. }
   gem.email = "tkachev.alex@gmail.com"
   gem.authors = ["Alex Tkachev"]
   # dependencies defined in Gemfile
@@ -38,8 +38,8 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/enum_records.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{enum_records}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2011-07-25}
+  s.description = %q{This gem allows to create enum records (named records) and to retrieve them easily. Supports globalize3 localization in enum fields initialization. }
   s.email = %q{tkachev.alex@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "enum_records.gemspec",
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       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"])
@@ -54,6 +55,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
       s.add_development_dependency(%q<globalize3>, [">= 0"])
     else
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
@@ -64,6 +66,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<globalize3>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

data/lib/enum_records.rb

@@ -40,7 +40,13 @@ module EnumRecords
     end
 
     module InstanceMethods
-
+      # return this instance enum atttributes as were passed at enum definition
+      # note that all atttributes are returned (both database and non database).
+      # note that database atttribute value can be different from enum attribute value (because it was changed in db by someone else)
+      def enum_attributes
+        enum_column_name =  self.class._enums[:column_name]
+        self.class._enums[:definitions][self.send(enum_column_name)]
+      end
     end
 
   end

data/spec/enum_records_spec.rb

@@ -69,6 +69,32 @@ describe "Document" do
     enums.should_not include(@non_enum)
   end
 
+  it 'should have non database attributes accessable' do
+    enum_doc = Document.enum(:about)
+    enum_doc.enum_attributes.should_not be_nil
+    enum_doc.enum_attributes[:html_title].should == 'about us'
+  end
+
+  it 'should return nil if it is not enum record and enum attributes requested' do
+    @non_enum.enum_attributes.should be_nil
+  end
+
+  context "when document is changed in db" do
+    it 'should have db attribute != enum attribute' do
+      enum_doc = Document.enum(:home)
+      enum_doc.name = '1234'
+      enum_doc.save.should be_true
+
+      Document.enum(:home).name.should_not == Document.enum(:home).enum_attributes[:name]
+      Document.enum(:home).enum_attributes[:name].should == 'Home page'
+      Document.enum(:home).name.should == '1234'
+
+      #restore original value
+      enum_doc.name = Document.enum(:home).enum_attributes[:name]
+      enum_doc.save.should be_true
+    end
+  end
+
 end
 
 describe "Page" do
@@ -78,9 +104,9 @@ describe "Page" do
 
   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.length.should == 4
+    Page.count.should == 5
+    enums.should include(Page.enum(:home), Page.enum(:profile), Page.enum(:project_categories), Page.enum(:ContactForm))
     enums.should_not include(@non_enum)
   end
 

data/spec/models/document.rb

@@ -3,7 +3,7 @@ class Document < ActiveRecord::Base
   
   define_enums do
     home :name => 'Home page'
-    about :name => 'About page'
+    about :name => 'About page', :html_title => 'about us'
     contact_form :name => 'Contact us'
   end
 

data/spec/models/page.rb

@@ -7,5 +7,6 @@ class Page < ActiveRecord::Base
     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=>'פרויקטים'}}
+    ContactForm :position=>3, :published=>true, :locales=>{'en-US'=>{:title=>'contact us'}, 'he-IL'=>{:title=>'יצירת קשר'}}
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: enum_records
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Alex Tkachev
@@ -15,12 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-24 00:00:00 +03:00
+date: 2011-07-25 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: 
+        - 0
+        version: "0"
+  type: :development
+  name: rdoc
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,10 +47,10 @@ dependencies:
         version: 2.3.0
   type: :development
   name: rspec
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,10 +63,10 @@ dependencies:
         version: 1.0.0
   type: :development
   name: bundler
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,10 +79,10 @@ dependencies:
         version: 1.6.4
   type: :development
   name: jeweler
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,10 +93,10 @@ dependencies:
         version: "0"
   type: :development
   name: rcov
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,10 +109,10 @@ dependencies:
         version: 3.0.9
   type: :development
   name: activerecord
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -111,10 +125,10 @@ dependencies:
         version: 3.0.9
   type: :development
   name: activesupport
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -125,10 +139,10 @@ dependencies:
         version: "0"
   type: :development
   name: sqlite3
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -139,8 +153,8 @@ dependencies:
         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. "
+  version_requirements: *id009
+description: "This gem allows to create enum records (named records) and to retrieve them easily. Supports globalize3 localization in enum fields initialization. "
 email: tkachev.alex@gmail.com
 executables: []
 
@@ -148,13 +162,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - .rspec
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - enum_records.gemspec