poppy-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeb0965a5f6d009488d4984973733776904bac7d
+  data.tar.gz: 1486ff47b5bff645776382658d865caf8f13c8c8
+SHA512:
+  metadata.gz: c17d3590665a899d65dce98b0daa81dc692e79e24c86240ba8218be8465c93abd9d43562aa38481d3b1b3e32865e7a04d3dc36f81ab44b5e337539e07d52ef8b
+  data.tar.gz: 168e49782116215895ab56456660a2f1256c60f71c9f485b061bea6ebf3cd6e267725f9bc316cfc1716fffb2a346675bbbbe767d8893d2178b851685a6bc6aa4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Damien Adermann
+
+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,119 @@
+# Poppy Rails
+
+A simple and flexible enumeration implementation for ActiveRecord. 
+
+
+*This release is very alpha. Use at your own risk but I would appreciate feedback.
+
+## Description
+
+Inspired by [enumerate_it](https://github.com/cassiomarques/enumerate_it), Poppy is a simple implementation of enumerations with minimal goodies. Poppy offers a few nice features:
+
+- Enumeration values are objects and can respond to methods
+- Works with postreSQL arrays with validations
+- Simple API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poppy-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poppy-rails
+
+**optional**
+
+Add an initializer that calls
+
+```ruby
+ActiveRecord::Base.include(Poppy::ActiveRecord)
+``` 
+
+this can be omitted by manually including the adapter in each model that uses Poppy
+
+```ruby
+class Sandwhich < ActiveRecord::Base
+	include Poppy::ActiveRecord
+	
+	enumeration :bread, of: Bread
+	#...
+end
+```
+
+
+## Usage
+
+
+### Model
+```ruby
+class Sandwhich < ActiveRecord::Bas
+	enumeration :bread, of: Bread
+	enumeration :cheeses, as: :array, of: Cheese
+end
+```
+Adding an enumeration to an active_record model will add an inclusion validation. There is no support for nullable enumerations. This is an intended design decision. If you would like this functionality you will need to add a null value
+E.g. ` Bread::None `
+
+If the enumeration is an array then all values in the array must be of that enumeration.
+
+### Migrations
+
+Just regular rails migrations
+
+```ruby
+class AddJobKindsToJob < ActiveRecord::Migration
+  def change
+    add_column :sandwhiches, :bread, :string, default: Bread::WHITE
+    add_column :sandwhiches, :cheeses, :string, array: true, default: []
+  end
+end
+```
+
+### In the wild
+
+```ruby
+> sandwhich = Sandwhich.new(bread: Bread::WHITE, cheeses: [Cheese::CHEDDAR])
+> sandwhich.bread
+=> Bread::WHITE
+
+> sandwhich.cheeses
+=> [Cheese::CHEDDAR]
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Specs depend rely on a postgres database running to test the array support.
+
+```bash
+$ createdb poppy-rails-test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/damienadermann/poppy-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+##TODO
+- Add AR initializer
+- Add travis.yml
+- Add badges
+- Add docs
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "poppy/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/poppy/active_record.rb

@@ -0,0 +1,69 @@
+require 'active_record'
+require 'active_record/connection_adapters/postgresql/oid/array'
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module Poppy
+  module ActiveRecord
+    PostgreSQLAdapter = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+    PostgreSQLArrayType = ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array
+
+    COLUMN_TYPES = %i(value array)
+    DEFAULT_COLUMN_TYPE = :value
+
+    class InvalidColumnTypeForAdapterTypeError < StandardError; end
+
+    include Poppy::Rails::Validators
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+
+      def enumeration(attribute_name, **options)
+        options.assert_valid_keys(:as, :of)
+        column_type = options.fetch(:as, DEFAULT_COLUMN_TYPE)
+        enumeration = options[:of]
+        define_type(attribute_name: attribute_name, column_type: column_type, enumeration: enumeration)
+        add_validation(attribute_name: attribute_name, column_type: column_type, enumeration: enumeration)
+      end
+
+      private
+
+      def define_type(attribute_name:, column_type:, enumeration:)
+        attribute attribute_name, type_for(column_type: column_type, enumeration: enumeration)
+      end
+
+      def  add_validation(attribute_name:, column_type:, enumeration:)
+        case column_type
+        when :value
+          validates attribute_name, inclusion: { in: enumeration.list }
+        when :array
+          validates attribute_name, enum_array: { as: enumeration }
+        end
+      end
+
+      def type_for(column_type:, enumeration:)
+        case column_type
+        when :value
+          value_type_for_enum(enumeration)
+        when :array
+          array_type_for_enum(enumeration)
+        end
+      end
+
+      def value_type_for_enum(enumeration)
+        EnumType.new(enum: enumeration)
+      end
+
+      def array_type_for_enum(enumeration)
+        raise InvalidColumnTypeForAdapterTypeError unless postgres_connection?
+        PostgreSQLArrayType.new(EnumType.new(enum: enumeration))
+      end
+
+      def postgres_connection?
+        ::ActiveRecord::Base.connection.is_a?(PostgreSQLAdapter)
+      end
+    end
+  end
+end

data/lib/poppy/active_record/enum_type.rb

@@ -0,0 +1,26 @@
+module Poppy
+  module ActiveRecord
+    class EnumType < ::ActiveRecord::Type::Value
+      class InvalidEnumerationError < StandardError; end;
+
+      attr_accessor :enum
+
+      def initialize(options)
+        options.assert_valid_keys(:precision, :scale, :limit, :enum)
+        @precision = options[:precision]
+        @scale = options[:scale]
+        @limit = options[:limit]
+        @enum = options[:enum]
+      end
+
+      def type_cast(value)
+        return value if enum.valid?(value)
+        enum.enum_for(value.to_sym)
+      end
+
+      def type_cast_for_database(value)
+        enum.key_for(value)
+      end
+    end
+  end
+end

data/lib/poppy/rails.rb

@@ -0,0 +1,11 @@
+require "poppy"
+require "poppy/rails/version"
+
+module Poppy
+  module Rails
+  end
+end
+
+require "poppy/rails/validators/enum_array_validator"
+require "poppy/active_record"
+require "poppy/active_record/enum_type"

data/lib/poppy/rails/validators/enum_array_validator.rb

@@ -0,0 +1,22 @@
+require 'active_model'
+
+module Poppy
+  module Rails
+    module Validators
+      class EnumArrayValidator < ::ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          record.errors.add(attribute, "must only only contain values of type #{enumeration}") unless valid_enums?(value)
+        end
+
+        private
+        def valid_enums?(array)
+          array.select{ |v| enumeration.valid?(v) }.count == array.count
+        end
+
+        def enumeration
+          options[:as]
+        end
+      end
+    end
+  end
+end

data/lib/poppy/rails/version.rb

@@ -0,0 +1,5 @@
+module Poppy
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/poppy-rails.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poppy/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "poppy-rails"
+  spec.version       = Poppy::Rails::VERSION
+  spec.authors       = ["Damien Adermann"]
+  spec.email         = ["damienadermann@gmail.com"]
+
+  spec.summary       = %q{Ruby On Rails integration for Poppy Enumerations}
+  spec.description   = %q{Simple Polymorphic enumerations for Ruby on Rails. Inspired by Enumerate_it, not inspired by ActiveRecord's enum}
+  spec.homepage      = "https://github.com/damienadermann/poppy-rails"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "poppy", "0.1.0"
+  spec.add_dependency "activerecord", "~> 4.2.0"
+
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: poppy-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damien Adermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: poppy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: byebug
+  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: Simple Polymorphic enumerations for Ruby on Rails. Inspired by Enumerate_it,
+  not inspired by ActiveRecord's enum
+email:
+- damienadermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/poppy/active_record.rb
+- lib/poppy/active_record/enum_type.rb
+- lib/poppy/rails.rb
+- lib/poppy/rails/validators/enum_array_validator.rb
+- lib/poppy/rails/version.rb
+- poppy-rails.gemspec
+homepage: https://github.com/damienadermann/poppy-rails
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby On Rails integration for Poppy Enumerations
+test_files: []