classy_enum 2.0.3 → 2.1.0

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/.travis.yml

@@ -1,3 +1,4 @@
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ClassyEnum Changelog
 
+## 2.1.0
+
+* Deprecating ClassyEnum::Base.enum_classes() (this is no longer needed)
+* Deprecating ClassyEnum::Base.valid_options()(use all.join(', ') instead)
+* Deprecating ClassEnum::Base.find() (use build() instead)
+
 ## 2.0.3
 
 * Fixes issue with validates_uniqueness_of when using an enum field as

data/Gemfile

@@ -1,11 +1,3 @@
 source :rubygems
 
-gem 'rails', '>= 3.0.0'
-
-group :development do
-  gem "jeweler", "~> 1.6.2"
-  gem "rspec-rails", "~> 2.8.1"
-  gem 'sqlite3'
-  gem 'json', '~> 1.6.5'
-  # gem 'ruby-debug19', :require => 'false'
-end
+gemspec

data/README.md

@@ -77,10 +77,10 @@ class Priority < ClassyEnum::Base
   end
 end
 
-class PriorityLow < priority
+class PriorityLow < Priority
 end
 
-class PriorityMedium < priority
+class PriorityMedium < Priority
 end
 
 class PriorityHigh < Priority
@@ -101,6 +101,9 @@ create_table "alarms", :force => true do |t|
 end
 ```
 
+Note: Alternatively, you may use an enum type if your database supports it. See
+[this issue](https://github.com/beerlington/classy_enum/issues/12) for more information.
+
 Then in my model I've added a line that calls `classy_enum_attr` with a single argument representing the enum I want to associate with my model. I am also delegating the send_email? method to my Priority enum class.
 
 ```ruby
@@ -132,24 +135,44 @@ The enum field works like any other model attribute. It can be mass-assigned usi
 
 ## Back reference to owning object
 
-In some cases you may want an enum class to be able to reference the owning object (an instance of the active record model). Think of it as a `belongs_to` relationship, where the enum can reference its owning object.
+In some cases you may want an enum class to reference the owning object
+(an instance of the active record model). Think of it as a `belongs_to`
+relationship, where the enum can reference its owning object.
 
-In order to create the back reference, you must declare how you wish to refer to the owner using the `owner` class method.
+By default, the back reference can be called using `owner`.
+If you want to refer to the owner by a different name, you must explicitly declare
+the owner name in the classy_enum parent class using the `owner` class method.
 
-For example:
+Example using the default `owner` method:
 
 ```ruby
 class Priority < ClassyEnum::Base
   enum_classes :low, :medium, :high
-  owner :alarm
 end
 
-class PriorityLow < priority
+...
+# low and medium subclasses omitted
+...
+
+class PriorityHigh < Priority
+  def send_email?
+    owner.enabled?
+  end
 end
+```
+
+Example where the owner reference is explicitly declared:
 
-class PriorityMedium < priority
+```ruby
+class Priority < ClassyEnum::Base
+  enum_classes :low, :medium, :high
+  owner :alarm
 end
 
+...
+# low and medium subclasses omitted
+...
+
 class PriorityHigh < Priority
   def send_email?
     alarm.enabled?
@@ -157,7 +180,7 @@ class PriorityHigh < Priority
 end
 ```
 
-In the above example, high priority alarms are only emailed if the owning alarm is enabled.
+In the above examples, high priority alarms are only emailed if the owning alarm is enabled.
 
 ```ruby
 @alarm = Alarm.create(:priority => :high, :enabled => true)

data/Rakefile

@@ -1,45 +1,6 @@
-# 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 = "classy_enum"
-  gem.summary = %Q{A class based enumerator utility for Ruby on Rails}
-  gem.description = %Q{A utility that adds class based enum functionality to ActiveRecord attributes}
-  gem.email = "github@lette.us"
-  gem.homepage = "http://github.com/beerlington/classy_enum"
-  gem.authors = ["Peter Brown"]
-  gem.license = "MIT"
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
 
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "classy_enum #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-

data/classy_enum.gemspec

@@ -1,78 +1,23 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/classy_enum/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = "classy_enum"
-  s.version = "2.0.3"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Brown"]
+  gem.email         = ["github@lette.us"]
+  gem.description   = "A utility that adds class based enum functionality to ActiveRecord attributes"
+  gem.summary       = "A class based enumerator utility for Ruby on Rails"
+  gem.homepage      = "http://github.com/beerlington/classy_enum"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Peter Brown"]
-  s.date = "2012-04-24"
-  s.description = "A utility that adds class based enum functionality to ActiveRecord attributes"
-  s.email = "github@lette.us"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rvmrc",
-    ".travis.yml",
-    "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "classy_enum.gemspec",
-    "gemfiles/Gemfile.rails-3.0.x",
-    "gemfiles/Gemfile.rails-3.1.x",
-    "gemfiles/Gemfile.rails-3.2.x",
-    "init.rb",
-    "lib/classy_enum.rb",
-    "lib/classy_enum/attributes.rb",
-    "lib/classy_enum/base.rb",
-    "lib/classy_enum/class_methods.rb",
-    "lib/classy_enum/instance_methods.rb",
-    "lib/generators/classy_enum/classy_enum_generator.rb",
-    "lib/generators/classy_enum/templates/enum.rb",
-    "spec/active_record_spec.rb",
-    "spec/classy_enum_attributes_spec.rb",
-    "spec/classy_enum_owner_reference_spec.rb",
-    "spec/classy_enum_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/beerlington/classy_enum"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.19"
-  s.summary = "A class based enumerator utility for Ruby on Rails"
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "classy_enum"
+  gem.require_paths = ["lib"]
+  gem.version       = ClassyEnum::VERSION
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.add_dependency('rails', '>= 3.0')
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_development_dependency(%q<rspec-rails>, ["~> 2.8.1"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<json>, ["~> 1.6.5"])
-    else
-      s.add_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_dependency(%q<rspec-rails>, ["~> 2.8.1"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<json>, ["~> 1.6.5"])
-    end
-  else
-    s.add_dependency(%q<rails>, [">= 3.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    s.add_dependency(%q<rspec-rails>, ["~> 2.8.1"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<json>, ["~> 1.6.5"])
-  end
-end
+  gem.add_development_dependency('rspec-rails', '~> 2.10.0')
+  gem.add_development_dependency('sqlite3', '~> 1.3.6')
+  gem.add_development_dependency('json', '~> 1.6.5')
 
+end

data/lib/classy_enum/class_methods.rb

@@ -18,6 +18,8 @@ module ClassyEnum
     #  Priority.build(:low) or PriorityLow.new
     #
     def enum_classes(*enums)
+      ActiveSupport::Deprecation.warn('enum_classes is deprecated, and will be removed in ClassyEnum 3.0. It is no longer needed.', caller)
+
       self.class_eval do
         class_attribute :enum_options, :base_class
 
@@ -68,7 +70,10 @@ module ClassyEnum
       object
     end
 
-    alias :find :build
+    def find(value, options={})
+      ActiveSupport::Deprecation.warn("find is deprecated, and will be removed in ClassyEnum 3.0. Use build(:member) instead.", caller)
+      build(value, options)
+    end
 
     # Returns an array of all instantiated enums
     #
@@ -108,6 +113,7 @@ module ClassyEnum
     #
     #  Priority.valid_options # => "low, medium, high"
     def valid_options
+      ActiveSupport::Deprecation.warn("valid_options is deprecated, and will be removed in ClassyEnum 3.0. Use all.join(', ') instead.", caller)
       self.enum_options.map(&:to_s).join(', ')
     end
 

data/lib/classy_enum/version.rb

@@ -0,0 +1,3 @@
+module ClassyEnum
+  VERSION = "2.1.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classy_enum
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,23 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,23 +42,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -92,23 +76,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.5
 description: A utility that adds class based enum functionality to ActiveRecord attributes
-email: github@lette.us
+email:
+- github@lette.us
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- .document
-- .rvmrc
+- .gitignore
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - classy_enum.gemspec
 - gemfiles/Gemfile.rails-3.0.x
 - gemfiles/Gemfile.rails-3.1.x
@@ -119,6 +99,7 @@ files:
 - lib/classy_enum/base.rb
 - lib/classy_enum/class_methods.rb
 - lib/classy_enum/instance_methods.rb
+- lib/classy_enum/version.rb
 - lib/generators/classy_enum/classy_enum_generator.rb
 - lib/generators/classy_enum/templates/enum.rb
 - spec/active_record_spec.rb
@@ -127,8 +108,7 @@ files:
 - spec/classy_enum_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/beerlington/classy_enum
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,17 +121,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3374934930458401417
+      hash: -4601389622693505403
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4601389622693505403
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A class based enumerator utility for Ruby on Rails
-test_files: []
+test_files:
+- spec/active_record_spec.rb
+- spec/classy_enum_attributes_spec.rb
+- spec/classy_enum_owner_reference_spec.rb
+- spec/classy_enum_spec.rb
+- spec/spec_helper.rb

data/.document

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

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.2

data/Gemfile.lock

@@ -1,109 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
-      mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    git (1.2.5)
-    hike (1.2.1)
-    i18n (0.6.0)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    journey (1.0.3)
-    json (1.6.6)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.3.2)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
-      bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    rspec-rails (2.8.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.8.0)
-    sprockets (2.1.2)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  jeweler (~> 1.6.2)
-  json (~> 1.6.5)
-  rails (>= 3.0.0)
-  rspec-rails (~> 2.8.1)
-  sqlite3

data/VERSION

@@ -1 +0,0 @@
-2.0.3