simple_enum-multiple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c89b6aec44c60fd0f92340755e106fae10546925
+  data.tar.gz: 1a1b9dd5c830ccb0db9de912f3894dc0ab3924f0
+SHA512:
+  metadata.gz: 14472b37550061066af8ac2eaefc98972ae007871e174b5d6299b3a40044207f7d9f827dce4378037d9d50339fd3c9b457320ee438f015a8d363af1e5a86ff1e
+  data.tar.gz: 99d65fa4d15fd14dfb5b0e78f2d3d720d1250f5a3d25718b77ca40386936af6f6b6188827bc2cb2e89a4c92d0e3bde175dde8b1063ad362577ff562dcf319c41

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_enum-multiple.gemspec
+gemspec
+
+# some development deps
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'sqlite3', platform: :ruby
+gem 'bson_ext', platform: :ruby
+
+# Code coverage on CI only
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Theo
+
+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,44 @@
+# SimpleEnum::Multiple
+
+SimpleEnum::Multiple is extension of SimpleEnum, which brings multi-select enum support to SimpleEnum.
+
+## ActiveRecord Quick start
+
+Add this to a model:
+```ruby
+as_enum :tags, [:iphone, :ipad, :macbook], accessor: :join_table
+```
+
+Then create the required tag_cds column using migrations:
+```ruby
+class AddTagsColumnToPost < ActiveRecord::Migration
+  def change
+    create_join_table :posts, :tags
+  end
+end
+```
+
+It will store multi-enums data in a join table, if you don't want a join table, you may use `bitwise` accessor:
+
+```ruby
+# Migration
+add_column :posts, :tag_cds, :integer
+
+# Model
+as_enum :tags, [:iphone, :ipad, :macbook], accessor: :bitwise
+```
+
+It will store multi-enums data in a integer column, and if you don't want SimpleEnum::Multiple manage how you store your data, you can use `multiple` accessor:
+
+```ruby
+# Model
+as_enum :tags, [:iphone, :ipad, :macbook], accessor: :multiple
+```
+
+This accessor will not handle how the data saved in the database, so you have to use something like `serialize :tag_cds`, or implement your own [Coder](https://github.com/rails/rails/blob/master/activerecord/lib/active_record/coders/json.rb).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+desc 'Default: run all unit tests for both ActiveRecord & Mongoid.'
+task :default => :spec
+
+desc 'Run rspec test suite'
+task :spec do
+  sh 'bundle exec rspec spec/'
+end
+
+# Mongodb
+directory "tmp/mongodb.data"
+desc 'Run mongodb in tmp/'
+task :mongodb => [:'tmp/mongodb.data'] do |t|
+  system "mongod", "--dbpath", "tmp/mongodb.data"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_enum/multiple"
+
+# 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/simple_enum/multiple/accessors/bitwise_accessor.rb

@@ -0,0 +1,23 @@
+require 'simple_enum/multiple/accessors/multiple_accessor'
+require 'simple_enum/multiple/coders/bitwise'
+
+module SimpleEnum
+  module Multiple
+    module Accessors
+      class BitwiseAccessor < MultipleAccessor
+        def init(klass)
+          source = self.source
+
+          klass.class_eval do
+            serialize source, SimpleEnum::Multiple::Coders::Bitwise
+          end
+        end
+
+        def scope(collection, value)
+          column = Arel::Nodes::Group.new(collection.arel_table[source]).to_sql
+          collection.where("#{column} >> ? & 1 = 1", value)
+        end
+      end
+    end
+  end
+end

data/lib/simple_enum/multiple/accessors/join_table_accessor.rb

@@ -0,0 +1,97 @@
+require 'simple_enum/multiple/accessors/multiple_accessor'
+
+module SimpleEnum
+  module Multiple
+    module Accessors
+      class JoinTableAccessor < MultipleAccessor
+        attr_accessor :table, :foreign_key, :remote_key
+
+        def init(klass)
+          klass_table_name = klass.table_name.to_s
+          join_table_name = [klass_table_name, name.pluralize].sort.join("_").to_sym
+          table = self.table = Arel::Table.new(join_table_name)
+
+          source = self.source
+          name = self.name
+
+          foreign_key = self.foreign_key = klass_table_name.singularize.foreign_key
+          remote_key = self.remote_key = name.singularize.foreign_key
+
+          connection = ActiveRecord::Base.connection
+
+          klass.class_eval do
+            attr_accessor source
+
+            define_method :"#{source}_changed?" do
+              instance_variable_get(:"@#{source}") !=
+                instance_variable_get(:"@#{source}_was")
+            end
+
+            define_method :"#{source}_was" do
+              instance_variable = instance_variable_get(:"@#{source}_was")
+              return instance_variable if instance_variable
+              sql = table.where(table[foreign_key].eq(self.id))
+                .project(table[remote_key])
+                .to_sql
+              original_cds = connection.send(:select, sql).rows.map(&:first)
+              instance_variable_set(:"@#{source}_was", original_cds)
+            end
+
+            define_method source do
+              instance_variable = instance_variable_get(:"@#{source}")
+              return instance_variable if instance_variable
+              instance_variable_set(:"@#{source}", send(:"#{source}_was").dup)
+            end
+
+            define_method :"update_#{source}!" do
+              return unless send(:"#{source}_changed?")
+              original_cds = send(:"#{source}_was")
+              current_cds = send(source)
+
+              # if any enum been removed
+              if (original_cds - current_cds).any?
+                delete_sql = table.where(table[foreign_key].eq(self.id))
+                  .where(table[remote_key].in(original_cds - current_cds))
+                  .compile_delete
+                  .to_sql
+                connection.send(:delete, delete_sql)
+              end
+
+              # if any enum been added
+              if (current_cds - original_cds).any?
+                insert_sql = table.create_insert.tap do |insert_manager|
+                  insert_manager.into table
+                  insert_manager.columns << table[foreign_key]
+                  insert_manager.columns << table[remote_key]
+
+                  values = (current_cds - original_cds).map do |id|
+                    "(#{self.id}, #{id})"
+                  end.join(", ")
+                  insert_manager.values = Arel::Nodes::SqlLiteral.new("VALUES #{values}")
+                end.to_sql
+                connection.send(:insert, insert_sql)
+              end
+            end
+
+            after_save :"update_#{source}!"
+          end
+        end
+
+        def was(object)
+          fetch_keys(object.send(:"#{source}_was").to_a)
+        end
+
+        def changed?(object)
+          object.send(:"#{source}_changed?")
+        end
+
+        def scope(collection, value)
+          join = Arel::Nodes::Group.new(table).to_sql
+          on = collection.arel_table[collection.primary_key].eq(table[foreign_key]).to_sql
+          collection.joins("INNER JOIN #{join} ON #{on}")
+            .where(table[foreign_key].eq(value))
+        end
+      end
+    end
+  end
+end

data/lib/simple_enum/multiple/accessors/multiple_accessor.rb

@@ -0,0 +1,72 @@
+require 'simple_enum/accessors/accessor'
+require 'simple_enum/multiple/collection_proxy'
+
+module SimpleEnum
+  module Multiple
+    module Accessors
+      class MultipleAccessor < SimpleEnum::Accessors::Accessor
+        def initialize(name, enum, source = nil, prefix = nil)
+          super
+          @source = source.to_s.presence || "#{@name.singularize}#{SimpleEnum.suffix.pluralize}"
+        end
+
+        def read(object)
+          CollectionProxy.new(read_before_type_cast(object), self)
+        end
+
+        def write(object, keys)
+          keys = filter_keys(Array.wrap(keys))
+          write_after_type_cast(object, fetch_values(keys)) && keys
+        end
+
+        def selected?(object, key = nil)
+          current = read_before_type_cast(object)
+          current.any? && if key
+              current.all? do
+                current.include?(enum.value(key))
+              end
+            else
+              true
+            end
+        end
+
+        def was(object)
+          fetch_keys(object.send(:attribute_was, source).to_a)
+        end
+
+        def scope(collection, value)
+          raise "scopes for accessor: :multiple are not supported!"
+        end
+
+        def filter_keys(keys)
+          keys.select do |key|
+            enum.value(key)
+          end
+        end
+
+        def fetch_keys(values)
+          values.map do |value|
+            enum.key(value)
+          end
+        end
+
+        def fetch_values(keys)
+          keys.map do |key|
+            enum.value(key)
+          end
+        end
+
+        private
+
+        def read_before_type_cast(object)
+          result = super
+          unless result
+            result = []
+            write_after_type_cast(object, result)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/simple_enum/multiple/accessors.rb

@@ -0,0 +1,16 @@
+require 'simple_enum/multiple/accessors/multiple_accessor'
+require 'simple_enum/multiple/accessors/join_table_accessor'
+require 'simple_enum/multiple/accessors/bitwise_accessor'
+
+module SimpleEnum
+  module Multiple
+    module Accessors
+      SimpleEnum::Accessors::ACCESSORS.merge!({
+        multiple: MultipleAccessor,
+        join_table: JoinTableAccessor,
+        bitwise: BitwiseAccessor
+      })
+
+    end
+  end
+end

data/lib/simple_enum/multiple/coders/bitwise.rb

@@ -0,0 +1,22 @@
+module SimpleEnum
+  module Multiple
+    module Coders
+      class Bitwise
+        def self.load(data)
+          n = data.to_i
+          (0..Math.log2(n).floor).reject do |i|
+            (n & (1 << i)).zero?
+          end
+        rescue FloatDomainError, Math::DomainError
+          []
+        end
+
+        def self.dump(array)
+          array.map do |i|
+            1 << i
+          end.reduce(&:+)
+        end
+      end
+    end
+  end
+end

data/lib/simple_enum/multiple/collection_proxy.rb

@@ -0,0 +1,30 @@
+module SimpleEnum
+  module Multiple
+    class CollectionProxy
+      attr_reader :origin, :accessor
+
+      def initialize(origin, accessor)
+        @origin, @accessor = origin, accessor
+      end
+
+      def push(*keys)
+        keys = accessor.filter_keys(keys)
+        origin.push(*accessor.fetch_values(keys)).uniq!
+        self
+      end
+      alias_method :<<, :push
+
+      def delete(key)
+        origin.delete(accessor.enum.value(key)) && key
+      end
+
+      def proxy
+        accessor.fetch_keys(origin)
+      end
+
+      alias_method :to_a, :proxy
+      delegate :inspect, :to_s, :==, to: :proxy
+
+    end
+  end
+end

data/lib/simple_enum/multiple/extension.rb

@@ -0,0 +1,11 @@
+module SimpleEnum
+  module Multiple
+    module Extension
+      def generate_enum_multiple_extension_for enum, accessor
+        accessor.init(self) if accessor.respond_to? :init
+      end
+    end
+  end
+end
+
+SimpleEnum.register_generator :multiple, SimpleEnum::Multiple::Extension

data/lib/simple_enum/multiple/version.rb

@@ -0,0 +1,5 @@
+module SimpleEnum
+  module Multiple
+    VERSION = "0.1.0"
+  end
+end

data/lib/simple_enum/multiple.rb

@@ -0,0 +1,10 @@
+require 'simple_enum/multiple/accessors'
+require 'simple_enum/multiple/collection_proxy'
+require 'simple_enum/multiple/extension'
+require 'simple_enum/multiple/version'
+
+module SimpleEnum
+  module Multiple
+    # Your code goes here...
+  end
+end

data/simple_enum-multiple.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_enum/multiple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_enum-multiple"
+  spec.version       = SimpleEnum::Multiple::VERSION
+  spec.authors       = ["Theo"]
+  spec.email         = ["bbtfrr@gmail.com"]
+
+  spec.summary       = %q{Multi-select enum support for SimpleEnum.}
+  spec.description   = %q{SimpleEnum::Multiple is extension of SimpleEnum, which brings multi-select enum support to SimpleEnum.}
+  spec.homepage      = "https://github.com/bbtfr/simple_enum-multiple"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_runtime_dependency 'simple_enum', '~> 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'activerecord', '>= 4.0.0'
+  spec.add_development_dependency 'mongoid', '>= 4.0.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: simple_enum-multiple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Theo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: SimpleEnum::Multiple is extension of SimpleEnum, which brings multi-select
+  enum support to SimpleEnum.
+email:
+- bbtfrr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_enum/multiple.rb
+- lib/simple_enum/multiple/accessors.rb
+- lib/simple_enum/multiple/accessors/bitwise_accessor.rb
+- lib/simple_enum/multiple/accessors/join_table_accessor.rb
+- lib/simple_enum/multiple/accessors/multiple_accessor.rb
+- lib/simple_enum/multiple/coders/bitwise.rb
+- lib/simple_enum/multiple/collection_proxy.rb
+- lib/simple_enum/multiple/extension.rb
+- lib/simple_enum/multiple/version.rb
+- simple_enum-multiple.gemspec
+homepage: https://github.com/bbtfr/simple_enum-multiple
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Multi-select enum support for SimpleEnum.
+test_files: []