dm-enum 0.0.0 → 0.0.1

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    coderay (0.9.8)
+    data_objects (0.10.6)
+      addressable (~> 2.1)
+    diff-lcs (1.1.3)
+    dm-core (1.1.0)
+      addressable (~> 2.2.4)
+    dm-do-adapter (1.1.0)
+      data_objects (~> 0.10.2)
+      dm-core (~> 1.1.0)
+    dm-migrations (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-sqlite-adapter (1.1.0)
+      dm-do-adapter (~> 1.1.0)
+      do_sqlite3 (~> 0.10.2)
+    do_sqlite3 (0.10.6)
+      data_objects (= 0.10.6)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    method_source (0.6.6)
+      ruby_parser (~> 2.0.5)
+    pry (0.9.6.2)
+      coderay (~> 0.9.8)
+      method_source (~> 0.6.5)
+      ruby_parser (~> 2.0.5)
+      slop (~> 2.1.0)
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.9)
+    slop (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  dm-core
+  dm-migrations
+  dm-sqlite-adapter
+  jeweler (~> 1.6.4)
+  pry
+  rspec (~> 2.3.0)

data/README.md

@@ -1,4 +1,4 @@
-# dm-enums (Enumrated models for DataMapper)
+# dm-enum (Enumrated models for DataMapper)
 by Potapov Sergey (aka Blake)
 
 Inspired by [power\_enum](https://github.com/albertosaurus/enumerations_mixin)
@@ -7,10 +7,18 @@ Inspired by [power\_enum](https://github.com/albertosaurus/enumerations_mixin)
 
 Allows you to cache enumeration models.
 
+
+## Installation
+
+    gem install dm-enum
+
 ## Usage
 
 ```ruby
 
+require 'dm-core'
+require 'dm-enum'
+
 class Language
   include DataMapper::Resource
   include DataMapper::Enum
@@ -33,7 +41,7 @@ Language["en"] # => #<Language @code="en" @name="English">
 ```
 
 
-## Contributing to dm-enums
+## Contributing to dm-enum
 
 * 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

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/dm-enum.gemspec

@@ -0,0 +1,70 @@
+# 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{dm-enum}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Potapov Sergey"]
+  s.date = %q{2012-03-02}
+  s.description = %q{Enumerated models for DataMapper to cache enumerated values in memory}
+  s.email = %q{blake131313@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "dm-enum.gemspec",
+    "lib/dm-enum.rb",
+    "lib/dm/enum.rb",
+    "spec/dm/enum_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/greyblake/dm-enum}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Enumerated models for DataMapper}
+
+  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_runtime_dependency(%q<dm-core>, [">= 0"])
+      s.add_development_dependency(%q<dm-migrations>, [">= 0"])
+      s.add_development_dependency(%q<dm-sqlite-adapter>, [">= 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"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0"])
+      s.add_dependency(%q<dm-migrations>, [">= 0"])
+      s.add_dependency(%q<dm-sqlite-adapter>, [">= 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"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0"])
+    s.add_dependency(%q<dm-migrations>, [">= 0"])
+    s.add_dependency(%q<dm-sqlite-adapter>, [">= 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"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/lib/dm-enum.rb

@@ -0,0 +1 @@
+require File.expand_path('enum', 'lib/dm')

data/lib/dm/enum.rb

@@ -0,0 +1,35 @@
+module DataMapper
+  module Enum
+    def self.included(receiver)
+      receiver.extend ClassMethods
+      attr_reader :name_property
+    end
+
+    module ClassMethods
+      def acts_as_enumerated(options = {})
+        @name_property = options.delete(:name_property) || :name
+        @enums_cache = {}
+      end
+
+      def update_enums_cache!
+        @enums_cache = {}
+        @cache_update_flag = true
+        all.each do |model|
+          name = model.send(@name_property).to_sym
+          @enums_cache[name] = model
+        end
+      end
+
+      def [](name)
+        if model = @enums_cache[name.to_sym]
+          model
+        elsif !@cache_update_flag
+          raise RuntimeError.new("Looks like you forgot to call `#{self}.update_enums_cache!` before using `#{self}[#{name.inspect}]`")
+        else
+          nil
+        end
+      end
+    end
+
+  end
+end

data/spec/dm/enum_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe DataMapper::Enum do
+  before :all do
+    Language.create(:code => "ru", :name => "Russian")
+    Country.create(:name => "Ukraine")
+    City.create(:name => "Kharkov")
+
+    Language.update_enums_cache!
+    Country.update_enums_cache!
+  end
+
+  describe '.[]' do
+    context 'name_property is other than default' do
+      context 'symbol passed' do
+        subject { Language[:ru] }
+
+        it { should be_an_instance_of Language }
+        its(:code) { should == 'ru' }
+        its(:name) { should == 'Russian' }
+      end
+
+      context 'string passed' do
+        subject { Language[:ru] }
+
+        it { should be_an_instance_of Language }
+        its(:code) { should == 'ru' }
+        its(:name) { should == 'Russian' }
+      end
+
+      context 'non-existing value' do
+        subject { Language[:wtf] }
+
+        it { should be_nil}
+      end
+    end
+
+    context 'default name_property' do
+      subject { Country[:Ukraine] }
+
+      it { should be_an_instance_of Country }
+      its(:name) { should == "Ukraine" }
+    end
+
+    context "forgot to call update_enums_cache!" do
+      it "raises an error with meaningful message" do
+        error_message = "Looks like you forgot to call `City.update_enums_cache!` before using `City[:Kharkov]`"
+        expect { City[:Kharkov] }.to raise_error(RuntimeError, error_message)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dm-enum
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dm-core
-  requirement: &17199560 !ruby/object:Gem::Requirement
+  requirement: &8845360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17199560
+  version_requirements: *8845360
 - !ruby/object:Gem::Dependency
   name: dm-migrations
-  requirement: &17198960 !ruby/object:Gem::Requirement
+  requirement: &8844680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17198960
+  version_requirements: *8844680
 - !ruby/object:Gem::Dependency
   name: dm-sqlite-adapter
-  requirement: &17198300 !ruby/object:Gem::Requirement
+  requirement: &8844140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17198300
+  version_requirements: *8844140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17197640 !ruby/object:Gem::Requirement
+  requirement: &8843540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *17197640
+  version_requirements: *8843540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &17196920 !ruby/object:Gem::Requirement
+  requirement: &8842700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *17196920
+  version_requirements: *8842700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &17196080 !ruby/object:Gem::Requirement
+  requirement: &8842040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *17196080
+  version_requirements: *8842040
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &17195360 !ruby/object:Gem::Requirement
+  requirement: &8841380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17195360
+  version_requirements: *8841380
 description: Enumerated models for DataMapper to cache enumerated values in memory
 email: blake131313@gmail.com
 executables: []
@@ -100,11 +100,16 @@ files:
 - .document
 - .rspec
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- README.md
 - Rakefile
 - VERSION
+- dm-enum.gemspec
+- lib/dm-enum.rb
+- lib/dm/enum.rb
+- spec/dm/enum_spec.rb
 - spec/spec_helper.rb
-- README.md
 has_rdoc: true
 homepage: http://github.com/greyblake/dm-enum
 licenses: