power_enum 0.5.5 → 0.6.0

data/README.md

@@ -47,6 +47,7 @@ This package adds:
 - Two mixins and a helper to ActiveRecord
 - Methods to migrations to simplify the creation of backing tables
 - A generator to make generating enums easy
+- Custom RSpec matchers to streamline the testing of enums and enumerated attributes (Since version 0.6.0)
 
 `acts_as_enumerated` provides capabilities to treat your model and its records as an enumeration.
 At a minimum, the database table for an acts\_as\_enumerated must contain an 'id' column and a column
@@ -433,6 +434,60 @@ accordingly.
 
 See virtual\_enumerations\_sample.rb in the examples directory of this gem for a full description.
 
+### Testing (Since version 0.6.0)
+
+A pair of custom RSpec matchers are included to streamline testing of enums and enumerated attributes.
+
+#### act\_as\_enumerated
+
+This is used to test that a model acts as enumerated.  Example:
+
+    describe BookingStatus do
+      it { should act_as_enumerated }
+    end
+
+This also works:
+
+    describe BookingStatus do
+      it "should act as enumerated" do
+        BookingStatus.should act_as_enumerated
+      end
+    end
+
+You can use the `with_items` chained matcher to test that each enum is properly seeded:
+
+    describe BookingStatus do
+      it {
+        should act_as_enumerated.with_items(:confirmed, :received, :rejected)
+      }
+    end
+
+You can also pass in hashes if you want to be thorough and test out all the attributes of each enum.  If
+you do this, you must pass in the `:name` attribute in each hash
+
+    describe BookingStatus do
+      it {
+        should act_as_enumerated.with_items({ :name => 'confirmed', :description => "Processed and confirmed" },
+                                            { :name => 'received', :description => "Pending confirmation" },
+                                            { :name => 'rejected', :description => "Rejected due to internal rules" })
+      }
+    end
+
+#### have\_enumerated
+
+This is used to test that a model has enumerated the given attribute:
+
+    describe Booking do
+      it { should have_enumerated(:status) }
+    end
+
+This is also valid:
+
+    describe Booking do
+      it "Should have enumerated the status attribute" do
+        Booking.should have_enumerated(:status)
+      end
+    end
 
 ## How to run tests
 

data/lib/power_enum.rb

@@ -1,4 +1,5 @@
 require "rails"
+require 'testing/rspec'
 
 class PowerEnum < Rails::Engine
   config.autoload_paths << File.expand_path(File.join(__FILE__, "../"))

data/lib/testing/rspec.rb

@@ -0,0 +1,146 @@
+if defined? RSpec
+  require 'rspec/expectations'
+
+  # This is used to test that a model acts as enumerated.  Example:
+  #
+  #     describe BookingStatus do
+  #       it { should act_as_enumerated }
+  #     end
+  #
+  # This also works:
+  #
+  #     describe BookingStatus do
+  #       it "should act as enumerated" do
+  #         BookingStatus.should act_as_enumerated
+  #       end
+  #     end
+  #
+  # You can use the `with_items` chained matcher to test that each enum is properly seeded:
+  #
+  #     describe BookingStatus do
+  #       it {
+  #         should act_as_enumerated.with_items(:confirmed, :received, :rejected)
+  #       }
+  #     end
+  #
+  # You can also pass in hashes if you want to be thorough and test out all the attributes of each enum.  If
+  # you do this, you must pass in the `:name` attribute in each hash
+  #
+  #     describe BookingStatus do
+  #       it {
+  #         should act_as_enumerated.with_items({ :name => 'confirmed', :description => "Processed and confirmed" },
+  #                                             { :name => 'received', :description => "Pending confirmation" },
+  #                                             { :name => 'rejected', :description => "Rejected due to internal rules" })
+  #       }
+  #     end
+  RSpec::Matchers.define :act_as_enumerated do
+
+    chain :with_items do |*args|
+      @items = args
+    end
+
+    match do |enum|
+      enum_class = get_enum_class(enum)
+
+      if enum_class.respond_to?(:[]) &&
+          enum_class.respond_to?(:enumeration_model_updates_permitted) &&
+          enum_class.respond_to?(:purge_enumerations_cache)
+
+        if @items
+          begin
+            @items.all? { |item| validate_enum(enum_class, item) }
+          rescue Exception
+            false
+          end
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    def get_enum_class(enum)
+      if enum.is_a?(Class)
+         enum
+       else
+         enum.class
+       end
+    end
+
+    def validate_enum(enum_class, item)
+      case item
+      when String, Symbol, Fixnum
+        enum_class[item].present?
+      when Hash
+        name = item[:name]
+        if (e = enum_class[name]).present?
+          item.all?{ |attribute, value|
+            e.send(attribute) == value
+          }
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
+    failure_message_for_should do
+      message = "should act as enumerated"
+      if @items
+        message << " and have members #{@items.inspect}"
+      end
+      message
+    end
+
+    failure_message_for_should_not do
+      message = "should not act as enumerated"
+      if @items
+        message << " and not have members #{@items.inspect}"
+      end
+      message
+    end
+
+    description do
+      "act as enumerated"
+    end
+  end
+
+  # This is used to test that a model has enumerated the given attribute:
+  #
+  #     describe Booking do
+  #       it { should have_enumerated(:status) }
+  #     end
+  #
+  # This is also valid:
+  #
+  #     describe Booking do
+  #       it "Should have enumerated the status attribute" do
+  #         Booking.should have_enumerated(:status)
+  #       end
+  #     end
+  RSpec::Matchers.define :have_enumerated do |attribute|
+    match do |model|
+      model_class = if model.is_a?(Class)
+                      model
+                    else
+                      model.class
+                    end
+      model_class.has_enumerated?(attribute)
+    end
+
+    failure_message_for_should do
+      "expected #{attribute} to be an enumerated attribute"
+    end
+
+    failure_message_for_should_not do
+      "expected #{attribute} to not be an enumerated attribute"
+    end
+
+    description do
+      "have enumerated #{attribute}"
+    end
+  end
+
+end

metadata

@@ -1,10 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: power_enum
-version: !ruby/object:Gem::Version
-  version: 0.5.5
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
-authors:
+authors: 
 - Trevor Squires
 - Pivotal Labs
 - Arthur Shagall
@@ -12,82 +17,98 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &15454380 !ruby/object:Gem::Requirement
+
+date: 2012-02-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
-  type: :runtime
+  version_requirements: *id001
+  name: rails
   prerelease: false
-  version_requirements: *15454380
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &15442580 !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: jeweler
   prerelease: false
-  version_requirements: *15442580
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &15440860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *15440860
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &15439280 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: rspec
+  prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: sqlite3
   prerelease: false
-  version_requirements: *15439280
-- !ruby/object:Gem::Dependency
-  name: genspec
-  requirement: &15438200 !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
         version: 0.2.1
-  type: :development
+  version_requirements: *id005
+  name: genspec
   prerelease: false
-  version_requirements: *15438200
-description: ! 'Power Enum allows you to treat instances of your ActiveRecord models
-  as though they were an enumeration of values.
-
-  It allows you to cleanly solve many of the problems that the traditional Rails alternatives
-  handle poorly if at all.
-
-  It is particularly suitable for scenarios where your Rails application is not the
-  only user of the database, such as
-
-  when it''s used for analytics or reporting.
+  type: :development
+description: |
+  Power Enum allows you to treat instances of your ActiveRecord models as though they were an enumeration of values.
+  It allows you to cleanly solve many of the problems that the traditional Rails alternatives handle poorly if at all.
+  It is particularly suitable for scenarios where your Rails application is not the only user of the database, such as
+  when it's used for analytics or reporting.
 
-'
 email: arthur.shagall@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.md
-files:
+files: 
 - examples/virtual_enumerations_sample.rb
 - lib/active_record/acts/enumerated.rb
 - lib/active_record/aggregations/has_enumerated.rb
@@ -101,34 +122,41 @@ files:
 - lib/power_enum/migration/command_recorder.rb
 - lib/power_enum/reflection.rb
 - lib/power_enum/schema/schema_statements.rb
+- lib/testing/rspec.rb
 - LICENSE
 - README.md
 homepage: http://github.com/albertosaurus/enumerations_mixin
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1905981418849188503
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Allows you to treat instances of your ActiveRecord models as though they
-  were an enumeration of values
+summary: Allows you to treat instances of your ActiveRecord models as though they were an enumeration of values
 test_files: []
+