enum_from_file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea76f67ea1318023b84e54b22e344e6efa214524bde46bc929dd8e02b5003783
+  data.tar.gz: b9640350d7207500b1634c0c172e5bf724b415298cf7dfe6744e012acf7ff3f3
+SHA512:
+  metadata.gz: 60b23f83a28e3d9acc095c49e8d55d9be4b4cecbf347f92e768e5dde36affbf6be70ea8319596a03eb5a56fb33ee77688e713aebc5968a59f9be745bdb321ff5
+  data.tar.gz: f3384394473e2647b373311eb695a2ebcb80cc4c5c7ad9c078674a4400cfa389f52534f005ec834ac15590c64d4d4a4ab1766ab68871deff9de4032683310331

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 andrew_r
+
+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,51 @@
+# EnumFromFile
+
+[![Build Status](https://semaphoreci.com/api/v1/andrewr224/enum-from-file/branches/master/badge.svg)](https://semaphoreci.com/andrewr224/enum-from-file)
+
+If you've ever found yourself in a situation where you feel like you should use enum, but it has 50 potions so you don't know where to put it, the answer is here!
+
+Just store your enums in a .yml file!
+
+This makes little sense when you have a small enum with just a couple of options, but the more options you have, the easier it is to see the benefits of using it.
+
+## Usage
+1. Create a folder `/config/enums` to store your enum files in .yml format.
+2. Add `include EnumFromFile` to the `ApplicationRecord` or your target model.
+3. Make sure your enum column has a type `string`.
+
+Et voila!
+
+Given a file `/config/enums/eye_colors.yml` you add eye_color enum to a Cat model with the following line:
+```ruby
+enum :eye_color, from_file: :eye_colors
+```
+
+You can continue using regular syntax for regular cases:
+```ruby
+enum status: { active: active, archived: archived }
+```
+
+All the options will be passed to native enum implementation as expected.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_from_file'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install enum_from_file
+```
+
+## Contributing
+Bug reports and pull requests are welcome on project's [page](https://github.com/andrewr224/enum-from-file) at GitHub
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EnumFromFile'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/enum_from_file.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "enum_from_file/railtie"
+require "enum_from_file/core_ext"
+
+module EnumFromFile
+  extend ActiveSupport::Concern
+
+  included do
+    include EnumFromFile::CoreExt
+  end
+end

data/lib/enum_from_file/core_ext.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "enum_from_file/storage"
+
+module EnumFromFile
+  module CoreExt
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def enum(enum_name = {}, **options)
+        if options.key?(:from_file)
+          options[enum_name] = enum_from_file(file: options.delete(:from_file))
+        end
+
+        super(options)
+      end
+
+      private
+
+      def enum_from_file(file:)
+        EnumFromFile::Storage.instance.send(file)
+      end
+    end
+  end
+end

data/lib/enum_from_file/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EnumFromFile
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/enum_from_file/storage.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module EnumFromFile
+  class Storage
+    include Singleton
+
+    def initialize
+      enum_files.each(&method(:define_enum))
+    end
+
+    private
+
+    def enum_files
+      Dir["#{project_root}/config/enums/*.yml"].map { |path| File.open(path) }
+    end
+
+    def project_root
+      return Rails.root   if defined?(Rails)
+      return Bundler.root if defined?(Bundler)
+
+      Dir.pwd
+    end
+
+    def define_enum(file)
+      define_singleton_method File.basename(file.path, ".yml") do
+        instance_variable_get(instance_name(file)) ||
+          instance_variable_set(instance_name(file), YAML.safe_load(file))
+      end
+    end
+
+    def instance_name(file)
+      "@#{File.basename(file.path, '.yml').to_sym}"
+    end
+  end
+end

data/lib/enum_from_file/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EnumFromFile
+  VERSION = "0.1.0"
+end

data/lib/tasks/enum_from_file_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :enum_from_file do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: enum_from_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- andrew_r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: pry-rails
+  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-rails
+  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: rubocop
+  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: rubocop-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: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Add `from_file` option to Rails enum.
+email:
+- andrew.r224@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/enum_from_file.rb
+- lib/enum_from_file/core_ext.rb
+- lib/enum_from_file/railtie.rb
+- lib/enum_from_file/storage.rb
+- lib/enum_from_file/version.rb
+- lib/tasks/enum_from_file_tasks.rake
+homepage: https://github.com/andrewr224/enum-from-file
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Load Rails enums from files!
+test_files: []