activerecord-real_enums 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f219b30cbc3e02a1183e61e56d728b873828bbfd
+  data.tar.gz: 474b1d789cca513f6f3f2bc563d0b6af00b933ea
+SHA512:
+  metadata.gz: 9de24cce1b13f9ee0854ea1d3a4c9861fa65eb607d2003de42ccf17dcf4da904fe85e561df179c477082eb6bb6f48b0600515fd7abc0c41f25c71353a1380b7c
+  data.tar.gz: 8feedcc09b4e0af38e6793b995b3d48fba87c6edb783969f93e6fad3662df0eb445cb34fbce327e68a70803670b02df22791eb61a89bf0416b9e5f14e7feefe6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Leif Gensert
+
+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,85 @@
+# Activerecord::RealEnums
+
+Supporting enumerations in Rails has up to now always been done on the application layer.
+
+The [symbolize](https://github.com/nofxx/symbolize) gem allows storing a limited set of different string values to a field. On a database level it is still possible to store abritrary strings.
+
+Rails 4.1 introduced [enums](http://api.rubyonrails.org/v4.1.0/classes/ActiveRecord/Enum.html) which fulfils the same purpose but stores the different types as integers. The mapping, validation is also handled on the application layer. And even worse in order to query for a specific enum it is necessary to lookup the according values for each query:
+
+    Conversation.where(status: Conversation.statuses[:archived])
+
+This gem takes advantage of the [PostgreSQL enum type](http://www.postgresql.org/docs/9.1/static/datatype-enum.html) that will handle all the validations:
+
+    Conversation.where(status: :archived)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-real_enums'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-real_enums
+
+## Usage
+
+### Migrations
+
+To be able to use PostgreSQL enums, I suggest to create the according type in a separate migration:
+
+    class CreateConversationStatusEnum < ActiveRecord::Migration
+      def up
+        execute "CREATE TYPE conversation_status AS ENUM ("active", "archived");"
+      end
+
+      def down
+        execute "DROP TYPE conversation_status;"
+      end
+    end
+
+from then on, the type `conversation_status` can be used as a regular type:
+
+    class AddColumnsToTeam < ActiveRecord::Migration
+      def change
+        add_column :conversations, :status, :conversation_status
+      end
+    end
+
+### Model
+
+To reference the type correctly (e.g. for queries) the enum needs to be added to the model:
+
+
+    class Converation < ActiveRecord::Base
+      real_enum :status, type: :conversation_status
+    end
+
+`real_enums` will add the necessary validations in the background.
+
+From then on, it is possible to query all conversations by status:
+
+    Conversation.where(status: :archived) # strings and symbols, both work
+
+
+## Caveats
+
+This is a first draft. Completely usable but not feature complete:
+
+  - no posibility to query all available values for enum
+  - currently only support for PostgreSQL (although [MySQL](http://dev.mysql.com/doc/refman/5.0/en/enum.html) also has an enum type)
+  - no helper methods for migration (AFAIK not officically supported to write own migration methods (that are reversible))
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/activerecord-real_enums/fork )
+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 a new Pull Request

data/Rakefile

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

data/activerecord-real_enums.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/real_enums/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-real_enums"
+  spec.version       = Activerecord::RealEnums::VERSION
+  spec.authors       = ["Leif Gensert"]
+  spec.email         = ["leif@propertybase.com"]
+  spec.summary       = "PG Enum support for AcviteRecord "
+  spec.description   = %q{Add support for Postgresql Enum type in ActiveRecord}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "activemodel"
+
+  spec.add_development_dependency "activerecord", ">= 4.0", "< 5.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/activerecord/real_enums.rb

@@ -0,0 +1,7 @@
+require "activerecord/real_enums/version"
+require "activerecord/real_enums/railtie"
+
+module ActiveRecord
+  module RealEnums
+  end
+end

data/lib/activerecord/real_enums/models/postgresql.rb

@@ -0,0 +1,30 @@
+module ActiveRecord
+  module RealEnums
+    module Models
+      module Postgresql
+        extend ActiveSupport::Concern
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def real_enum(name, options)
+            sql = "SELECT unnest(enum_range(NULL::#{options.fetch(:type)}))"
+
+            values = ::ActiveRecord::Base.
+              connection.
+              execute(sql).
+              map { |e| e["unnest"] }
+
+            validates_inclusion_of(name, in: values)
+          end
+        end
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ActiveRecord::RealEnums::Models::Postgresql
+end

data/lib/activerecord/real_enums/railtie.rb

@@ -0,0 +1,18 @@
+module ActiveRecord
+  module RealEnums
+    require "rails"
+    class Railtie < Rails::Railtie
+      initializer "real_enums.insert_into_active_record" do
+        ActiveSupport.on_load :active_record do
+          case ::ActiveRecord::Base.connection
+          when ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+            require "activerecord/real_enums/models/postgresql"
+            ::ActiveRecord::Base.send :include, ActiveRecord::RealEnums::Models::Postgresql
+          else
+            warn("enum type not supported in this DB type")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/real_enums/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module RealEnums
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-real_enums
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leif Gensert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Add support for Postgresql Enum type in ActiveRecord
+email:
+- leif@propertybase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-real_enums.gemspec
+- lib/activerecord/real_enums.rb
+- lib/activerecord/real_enums/models/postgresql.rb
+- lib/activerecord/real_enums/railtie.rb
+- lib/activerecord/real_enums/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: PG Enum support for AcviteRecord
+test_files: []