active_record_enumerated_type 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzgwY2UwNzY2OTIxZDhiNGI1MjQwNzkwYTI5Mjk1ZTM3YWM4YzFjMQ==
+  data.tar.gz: !binary |-
+    OGE0NzFjYzBhNzAyZWQ0YzJlNjA3NTdlNzkwMzJkYmViOWY1Y2Y5Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjhkODUwMTAyZjg4NWZjMDZkMzAzODUyMzUyOGJhNTJhYzNhNjJkYmE0YmNk
+    ZTU0ZjM5MGU4ZTkzNzNjNTZiOGQ1NmZhZjA1ZjQ4M2JkMGIyYmE1YmMwMGUw
+    OWJmZDFiYWY2YjEwNjZkYmMxYjU0ZTBmMzAxOGViZTg2YmVkNzY=
+  data.tar.gz: !binary |-
+    NWJhZGNkZGNjZGNiNmQ5ZmYwNTJhYjI1Yzk5NGEwZWVkMmZjZDU5MWI4MDJk
+    NGUwMmI5OGUwZjdmMzcwNjU5YTljYjA5OTZmMmFlNDNkZmRhNjgxMGY4NTEz
+    ODg1Njk5NmNmYWU0NzhiZjNiMDFkNDNhMGNlMmQ4YzJmYzIyOGQ=

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_enumerated_type.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Eddy
+
+MIT License
+
+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.md

@@ -0,0 +1,90 @@
+# ActiveRecord Enumerated Type
+
+Integrates [EnumeratedType](https://github.com/rafer/enumerated_type) with ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_record_enumerated_type'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_enumerated_type
+
+## Usage
+
+__1. Create a formal type__
+
+For example, per the [EnumeratedType](https://github.com/rafer/enumerated_type) documentation, a `JobStatus`:
+
+```Ruby
+class JobStatus
+  include EnumeratedType
+
+  declare :started
+  declare :finished
+end
+```
+
+__2. Restrict an ActiveRecord attribute to the type.__
+
+For example, assuming a `Job` class with a `status` attribute:
+
+```Ruby
+class Job < ActiveRecord::Base
+  restrict_type_of :status, to: JobStatus
+end
+```
+
+This allows one to set attributes symbolically or as formal types.
+
+```Ruby
+job = Job.new(status: JobStatus[:started])
+job.status # => JobStatus[:started]
+
+job = Job.new(status: :started)
+job.status # => JobStatus[:started]
+
+job = Job.new(status: nil)
+job.status # => nil
+```
+
+Setting an invalid type raises an exception.
+
+```Ruby
+job = Job.new(status: :pending)
+# => "'pending' is not a valid type for status. Valid types include 'started' and 'finished'."
+```
+
+### I18n support
+Type names can be translated with I18n.
+
+```YML
+en:
+  enumerated_type:
+    job_status:
+      finished: Finito
+```
+
+```Ruby
+job = Job.new(status: :finished)
+job.status.human
+# => 'Finito'
+
+job = Job.new(status: :started)
+job.status.human
+# => 'started'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active_record_enumerated_type.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_enumerated_type/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_enumerated_type"
+  spec.version       = ActiveRecordEnumeratedType::VERSION
+  spec.authors       = ["Ben Eddy"]
+  spec.email         = ["bae@foraker.com"]
+  spec.description   = %q{Enumerated types for ActiveRecord attributes}
+  spec.summary       = %q{Enumerated types for ActiveRecord attributes}
+  spec.homepage      = "https://github.com/foraker/active_record_enumerated_type"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "i18n"
+  spec.add_dependency "enumerated_type"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/active_record_enumerated_type.rb

@@ -0,0 +1,7 @@
+require "active_record_enumerated_type/version"
+require "active_record_enumerated_type/enumerated_type"
+require "active_record_enumerated_type/active_record/type_restriction"
+require "active_record_enumerated_type/rails"
+
+module ActiveRecordEnumeratedType
+end

data/lib/active_record_enumerated_type/active_record/type_restriction.rb

@@ -0,0 +1,26 @@
+module ActiveRecord
+  module TypeRestriction
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def restrict_type_of(attribute, options)
+        type_class = options.fetch(:to)
+
+        define_method(attribute) do
+          super() && type_class[super().to_sym]
+        end
+
+        define_method(:"#{attribute}=") do |value|
+          begin
+            super(value.presence && type_class.coerce(value).serialize)
+          rescue ArgumentError
+            valid_types = type_class.map { |type| "'#{type}'" }.to_sentence
+            raise TypeError, "'#{value}' is not a valid type for #{attribute}. Valid types include #{valid_types}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record_enumerated_type/enumerated_type.rb

@@ -0,0 +1,11 @@
+module EnumeratedType
+  def serialize
+    name
+  end
+
+  def human
+    I18n.translate!(name, scope: [:enumerated_type, :status])
+  rescue I18n::MissingTranslationData
+    to_s.titleize
+  end
+end

data/lib/active_record_enumerated_type/rails.rb

@@ -0,0 +1,3 @@
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, ActiveRecord::TypeRestriction)
+end

data/lib/active_record_enumerated_type/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordEnumeratedType
+  VERSION = "0.0.1"
+end

data/spec/enumerated_type_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe EnumeratedType do
+  describe "I18n" do
+    it "returns an internationalized name" do
+      allow(I18n).to receive(:translate!)
+        .with(:finished, scope: [:enumerated_type, :status])
+        .and_return("finito")
+
+      expect(Status[:finished].human).to eq "finito"
+    end
+
+    it "defaulst to the name" do
+      expect(Status[:finished].human).to eq "Finished"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'active_support/core_ext'
+require 'enumerated_type'
+require 'active_record_enumerated_type'
+
+class Status
+  include EnumeratedType
+
+  declare :started
+  declare :finished
+end
+
+RSpec.configure do |config|
+end

data/spec/type_restriction_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+class TestRecord
+  include ActiveRecord::TypeRestriction
+
+  module InheritedAttributes
+    def status
+      @status
+    end
+
+    def status=(value)
+      @status = value
+    end
+  end
+  include InheritedAttributes
+
+  restrict_type_of :status, to: Status
+end
+
+describe TestRecord do
+  describe "setting attributes" do
+    let(:instance) { described_class.new }
+
+    it "accepts a formal type" do
+      instance.status = Status[:started]
+      expect(instance.status).to eq Status[:started]
+    end
+
+    it "accepts a symbolic type" do
+      instance.status = :started
+      expect(instance.status).to eq Status[:started]
+    end
+
+    it "accepts a string type" do
+      instance.status = 'started'
+      expect(instance.status).to eq Status[:started]
+    end
+
+    it "allows type resetting" do
+      instance.status = Status[:started]
+      instance.status = Status[:finished]
+      expect(instance.status).to eq Status[:finished]
+    end
+
+    it "allows nil" do
+      instance.status = nil
+      expect(instance.status).to be_nil
+    end
+
+    it "raises an exception when types are invalid" do
+      error_message = "'pending' is not a valid type for status. Valid types include 'started' and 'finished'."
+
+      expect {
+        instance.status = :pending
+      }.to raise_error(TypeError, error_message)
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: active_record_enumerated_type
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Eddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: enumerated_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enumerated types for ActiveRecord attributes
+email:
+- bae@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_enumerated_type.gemspec
+- lib/active_record_enumerated_type.rb
+- lib/active_record_enumerated_type/active_record/type_restriction.rb
+- lib/active_record_enumerated_type/enumerated_type.rb
+- lib/active_record_enumerated_type/rails.rb
+- lib/active_record_enumerated_type/version.rb
+- spec/enumerated_type_spec.rb
+- spec/spec_helper.rb
+- spec/type_restriction_spec.rb
+homepage: https://github.com/foraker/active_record_enumerated_type
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Enumerated types for ActiveRecord attributes
+test_files:
+- spec/enumerated_type_spec.rb
+- spec/spec_helper.rb
+- spec/type_restriction_spec.rb
+has_rdoc: