sql_enum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91024ad7ccdb1b3b159c67f76dccc9682a8057c4
+  data.tar.gz: 3c65cc103e2e53eddc9c7f60c7a8bb698d10fba5
+SHA512:
+  metadata.gz: 6e35eb50be5ed87033e42f4932d95837b770c6870ed8c1b27d77c2f8cccbe1c695aee4d5c0784b91afda2e34371c1e598b14280cde49801fc0bfb296719b10ed
+  data.tar.gz: db9b719cfa23bb8c2a2175f6851f13bc7a3c83d085b3f4da03b800acb808ed4be3882d8f1d687b2d0091143e36b0a45cb412882f976426ac5e4c6098a69575a2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fletch@fzf.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sql_enum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    sql_enum (0.1.0)
+      activerecord (~> 5.x)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sql_enum!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Fletcher Fowler
+
+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,43 @@
+# SqlEnum
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sql_enum`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sql_enum
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fzf/sql_enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SqlEnum project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fzf/sql_enum/blob/master/CODE_OF_CONDUCT.md).

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 "sql_enum"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/active_record/connection_adapters/abstract_mysql.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractMysqlAdapter
+      def initialize_type_map_with_enum(m)
+        initialize_without_enum(m)
+        register_enum_type(m)
+      end
+
+      alias_method :initialize_without_enum, :initialize_type_map
+      alias_method :initialize_type_map, :initialize_type_map_with_enum
+
+      def register_enum_type(mapping)
+        mapping.register_type(%r(enum)i) do |sql_type|
+          Type::Enum.new(limit: sql_type.scan(/\w+/).reject{|v| v == 'enum'})
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/mysql/column_methods.rb

@@ -0,0 +1,14 @@
+require 'active_record/connection_adapters/mysql/schema_definitions'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module MySQL
+      module ColumnMethods
+        def enum(*args, **options)
+          args.each { |name| column(name, :enum, options) }
+        end
+      end
+    end
+  end
+end
+

data/lib/active_record/connection_adapters/mysql2.rb

@@ -0,0 +1,22 @@
+require 'active_record/connection_adapters/mysql2_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Mysql2Adapter
+      def native_database_types
+        self.class::NATIVE_DATABASE_TYPES.merge(enum: {name: "enum"})
+      end
+
+      def type_to_sql_with_enum(type, limit: nil, precision: nil, scale: nil, unsigned: nil, **)
+        if type.to_sym == :enum
+          "#{type}(#{limit.map{|n| "'#{n}'"}.join(",")})"
+        else
+          type_to_sql_without_enum(type, limit: limit, precision: precision, scale: scale, unsigned: unsigned)
+        end
+      end
+
+      alias_method :type_to_sql_without_enum, :type_to_sql
+      alias_method :type_to_sql, :type_to_sql_with_enum
+    end
+  end
+end

data/lib/active_record/enum/enum_type.rb

@@ -0,0 +1,41 @@
+module ActiveRecord
+  module Enum
+    class EnumType < Type::Value # :nodoc:
+      delegate :type, to: :subtype
+
+      def initialize(name, mapping, subtype)
+        @name = name
+        @mapping = mapping
+        @subtype = subtype
+      end
+
+      def cast(value)
+        return if value.blank?
+
+        if valid?(value)
+          value.to_s
+        else
+          assert_valid_value(value)
+        end
+      end
+
+      def deserialize(value)
+        value
+      end
+
+      def serialize(value)
+        value.to_s
+      end
+
+      def valid?(value)
+        mapping.include?(value.to_s)
+      end
+
+      def assert_valid_value(value)
+        unless value.blank? || valid?(value)
+          raise ArgumentError, "'#{value}' is not a valid #{name}"
+        end
+      end
+    end
+  end
+end

data/lib/active_record/enum_override.rb

@@ -0,0 +1,70 @@
+require 'active_record/enum'
+
+module ActiveRecord
+  module Enum
+    def sql_enum(name, options={})
+      enum_prefix = options.delete(:_prefix)
+      enum_suffix = options.delete(:_suffix)
+      klass       = self
+      enum_values = Array.new
+      name        = name.to_sym
+
+      detect_enum_conflict!(name, name.to_s.pluralize, true)
+      klass.singleton_class.send(:define_method, name.to_s.pluralize) { enum_values }
+
+      detect_enum_conflict!(name, name)
+      detect_enum_conflict!(name, "#{name}=")
+
+      attr = attribute_alias?(name) ? attribute_alias(name) : name
+      decorate_attribute_type(attr, :enum) do |subtype|
+        EnumType.new(attr, enum_values, subtype)
+      end
+
+      enum_values = values(name)
+      enum_values.each do |value|
+        if enum_prefix == true
+          prefix = "#{name}_"
+        elsif enum_prefix
+          prefix = "#{enum_prefix}_"
+        end
+        if enum_suffix == true
+          suffix = "_#{name}"
+        elsif enum_suffix
+          suffix = "_#{enum_suffix}"
+        end
+
+        value_method_name = "#{prefix}#{value}#{suffix}"
+
+        # def active?() status == 0 end
+        klass.send(:detect_enum_conflict!, name, "#{value_method_name}?")
+        define_method("#{value_method_name}?") { self[attr] == value.to_s }
+
+        # def active!() update! status: :active end
+        klass.send(:detect_enum_conflict!, name, "#{value_method_name}!")
+        define_method("#{value_method_name}!") { update!(attr => value) }
+
+        # scope :active, -> { where status: 0 }
+        klass.send(:detect_enum_conflict!, name, value_method_name, true)
+        klass.scope value_method_name, -> { where(attr => value) }
+      end
+      defined_enums[name.to_s] = enum_values
+    end
+
+    def values(name)
+      schema_values(name).scan(/\w+/).reject{|v| v == 'enum'}
+    end
+
+    def schema_values(name)
+      ActiveRecord::Base.connection.exec_query(schema_values_query(name)).rows[0][0]
+    end
+
+    def schema_values_query(name)
+      %{
+        SELECT column_type
+        FROM information_schema.COLUMNS
+        WHERE TABLE_NAME = '#{self.table_name}'
+        AND COLUMN_NAME = '#{name}'
+      }
+    end
+  end
+end

data/lib/active_record/type/enum.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Type
+    class Enum < Type::Value
+      def type
+        :enum
+      end
+    end
+  end
+end

data/lib/sql_enum/version.rb

@@ -0,0 +1,3 @@
+module SqlEnum
+  VERSION = "0.1.1"
+end

data/lib/sql_enum.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+require_relative 'active_record/enum/enum_type'
+require_relative 'active_record/type/enum'
+require_relative 'active_record/enum_override'
+require_relative 'active_record/connection_adapters/mysql2'
+require_relative 'active_record/connection_adapters/abstract_mysql'
+require_relative 'active_record/connection_adapters/mysql/column_methods'
+require_relative "sql_enum/version"
+
+module SqlEnum
+end

data/sql_enum.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sql_enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sql_enum"
+  spec.version       = SqlEnum::VERSION
+  spec.authors       = ["Fletcher Fowler"]
+  spec.email         = ["fletch@fzf.me"]
+
+  spec.summary       = %q{Enable using native sql enums}
+  spec.homepage      = "https://github.com/1debit/sql_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: sql_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Fletcher Fowler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- fletch@fzf.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_record/connection_adapters/abstract_mysql.rb
+- lib/active_record/connection_adapters/mysql/column_methods.rb
+- lib/active_record/connection_adapters/mysql2.rb
+- lib/active_record/enum/enum_type.rb
+- lib/active_record/enum_override.rb
+- lib/active_record/type/enum.rb
+- lib/sql_enum.rb
+- lib/sql_enum/version.rb
+- sql_enum.gemspec
+homepage: https://github.com/1debit/sql_enum
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Enable using native sql enums
+test_files: []