string_enumerate 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93f60f669c7ab6742be41b34618e0a4cb0027996
+  data.tar.gz: ea8bd9c0cee7234ff1f5cfbc7b40bcd4549ac543
+SHA512:
+  metadata.gz: 83db5c8f46315b6d2625380d675067098c1f64d21c8b23245c0f0e6094467bb1c1bb56aa01fcff1dcaaba490d1aeebaff025fd73d4b4270cfa448bf25c7dd40a
+  data.tar.gz: abde7ff1e2c2c6922687b9a528dd10bf60cd7721672c4ab3197091febb742bd9fa4c72c67141427a9de45999cf71f920924c144b3fccb90479220e796b52a3b0

data/.gitignore

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

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 se.ustinov@gmail.com. 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,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in string_enumerate.gemspec
+gemspec
+
+gem 'app_env_config'
+gem "rails", "~> 5.2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey U
+
+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,47 @@
+# StringEnumerate
+
+Gem provide ability to use enum of active record with string field at DB and store available values at config(yml file)
+
+@todo add description, tests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string_enumerate'
+```
+
+And then execute:
+
+    $ bundle
+
+    $ rails g string_enumerate:install
+
+## Usage
+
+app/models/post.rb
+```ruby
+class Post < ApplicationRecord
+  enumerate :status
+  ....
+end
+```
+
+config/models.yml
+``` yaml
+# YAML
+post:
+  statuses:
+    - draft
+    - published
+    - archived
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/string_enumerate. 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).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_enumerate"
+
+# 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/generators/string_enum/install_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/base'
+
+module StringEnumerate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'create config file at application and set MODELS constant for next use'
+
+      def create_yml
+        create_file 'config/models.yml'
+      end
+
+      def create_constant
+        write_to_file(
+          file: 'config/environment.rb',
+          line: 'Rails.application.initialize!',
+          content_before: "MODELS = AppEnvConfig.get('models', false)",
+          shift: "\n" * 2
+        )
+      end
+
+      protected
+
+      def file_contain_content?(options = {})
+        file_content = File.read(options[:file])
+
+        (options[:content_before].blank? || file_content.include?(options[:content_before])) &&
+          (options[:content_after].blank? || file_content.include?(options[:content_after]))
+      end
+
+      def write_to_file(options = {})
+        return if file_contain_content?(options)
+
+        gsub_file options[:file], /(#{Regexp.escape(options[:line])})/mi do |match|
+          [
+            options[:content_before].presence,
+            match,
+            options[:content_after].presence
+          ].compact.join(options.fetch(:shift, "\n"))
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/app_config.yml

@@ -0,0 +1,11 @@
+default: &default
+  title: App title
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default

data/lib/string_enumerate/models.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module StringEnumerate
+  module Models
+    extend ActiveSupport::Concern
+ 
+    module ClassMethods
+      def enumerate(*fields)
+        set_enumerate_fields fields
+        before_validation :set_enum_fields
+      end
+
+      def set_enumerate_fields(fields) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Naming/AccessorMethodName
+        enumerate_fields = class_variable_get(:@@enumerate_fields) rescue nil # rubocop:disable Style/RescueModifier
+        enumerate_fields ||= {}.with_indifferent_access
+
+        enumerate_fields[name.underscore] ||= {}
+
+        fields.each do |field|
+          if field.is_a?(Hash)
+            (prefix = field[:prefix]) || (suffix = field[:suffix])
+            set_default = field[:set_default]
+            field = field[:field]
+          else
+            prefix = nil
+            suffix = nil
+            set_default = nil
+          end
+
+          enumeration_labels(field).each_with_object(prepared_labels = {}) do |k|
+            key = k.is_a?(Array) ? k.first : k
+            prepared_labels[key] = key
+          end
+
+          enumerate_fields[name.underscore][field] = {
+            field => prepared_labels,
+            _prefix: prefix,
+            _suffix: suffix
+          }
+
+          enum enumerate_fields[name.underscore][field]
+
+          enumerate_fields[name.underscore][field][:set_default] = set_default
+        end
+
+        class_variable_set :@@enumerate_fields, enumerate_fields
+      end
+
+      def enumeration_labels(field)
+        if (res = MODELS[name.underscore] && MODELS[name.underscore][field.to_s.pluralize])
+          return res
+        end
+
+        raise(
+          "Please set list of values in config/model.yml
+          for model '#{name.underscore}' with key '#{field.to_s.pluralize}'"
+        )
+      end
+
+      def enumeration_key_by_index(field, index)
+        enumeration_labels(field).to_a[index.to_i].first
+      end
+
+      def enumeration_label_by_index(field, index)
+        enumeration_labels(field).to_a[index.to_i].last
+      end
+    end
+
+    protected
+
+    def set_enum_changed_at(field) # rubocop:disable Naming/AccessorMethodName
+      return if changes[field].blank? || !attribute_names.include?("#{field}_changed_at")
+
+      send("#{field}_changed_at=", Time.zone.now)
+    end
+
+    def set_enum_default(field, values)
+      return if enumerate_fields[self.class.name.underscore][field][:set_default] == false
+
+      return if send(field).present?
+
+      send("#{field}=", values.to_a.first.first)
+    end
+
+    def enumerate_fields
+      self.class.class_variable_get(:@@enumerate_fields)
+    rescue NameError
+      Rails.logger 'no enumerate fields'
+      nil
+    end
+
+    def set_enum_fields
+      return unless enumerate_fields
+
+      defined_enums.each do |field, values|
+        set_enum_default(field, values)
+
+        set_enum_changed_at(field)
+      end
+    end
+  end
+end

data/lib/string_enumerate/orm/active_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'orm_adapter/adapters/active_record'
+
+ActiveSupport.on_load(:active_record) do
+  include StringEnumerate::Models
+end

data/lib/string_enumerate/version.rb

@@ -0,0 +1,3 @@
+module StringEnumerate
+  VERSION = '0.1.4'
+end

data/lib/string_enumerate.rb

@@ -0,0 +1,2 @@
+require 'string_enumerate/models'
+require 'string_enumerate/orm/active_record'

data/string_enumerate.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "string_enumerate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_enumerate"
+  spec.version       = StringEnumerate::VERSION
+  spec.authors       = ["Sergey U"]
+  spec.email         = ["se.ustinov@gmail.com"]
+
+  spec.summary       = 'String field for ActiveRecord::Enum'
+  spec.description   = 'Gem provide ability to use enum of active record with string field at postgreSQL and store available values at config(yml file)'
+  spec.homepage      = 'https://github.com/sergeyustinov/string_enumerate'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency("orm_adapter", "~> 0.1")
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: string_enumerate
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Sergey U
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Gem provide ability to use enum of active record with string field at
+  postgreSQL and store available values at config(yml file)
+email:
+- se.ustinov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/string_enum/install_generator.rb
+- lib/generators/templates/app_config.yml
+- lib/string_enumerate.rb
+- lib/string_enumerate/models.rb
+- lib/string_enumerate/orm/active_record.rb
+- lib/string_enumerate/version.rb
+- string_enumerate.gemspec
+homepage: https://github.com/sergeyustinov/string_enumerate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sergeyustinov/string_enumerate
+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.6.13
+signing_key: 
+specification_version: 4
+summary: String field for ActiveRecord::Enum
+test_files: []