nd-enum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14980decd9ccdc766c2e27fc1c224a4dc94aee5bce41069fa574a58abe29f60f
-  data.tar.gz: 908d743ac4486cd835370ec06034661c15fc1b30dc4cf196cf02bdeb03f234ea
+  metadata.gz: 0c3a846e4f2d4625cfa4defce4320e1b6a66d2328a5bab3aad579fee30bddd2f
+  data.tar.gz: b872195ecf8bfaf2d381cf8eb07647c1317d71b7fd49a7044bcd8e8256f8b98a
 SHA512:
-  metadata.gz: f02d420631940aec368decfa880ba8f956b7675a40d2ce9a5f7704b838c912f62056b271ad53afb9584c6e9539f17b89371b3992f785d123fc6c4d1f16261417
-  data.tar.gz: 6f194a9f4b8396a46b8198af254648d7bf50c5291245e42afbbfdd06729dc31d621b3b602015a1c338809fc539cc15b62b1ecdbae6466e50691b93b031c370f1
+  metadata.gz: bab3df4478ed3eda30c254a380c69d29c690abbc371e03fc923c353fb90e5c3259aef0839cde49402a9961d6da8035006356195df81a7b9cc43f9f5d626b5019
+  data.tar.gz: d772f43733c33204c0acaafb9d0d38c797cebb603efc4ae311990f8afac2eb15a4538ade187b5f4df8dc489cf6e7ddd54548a0ef021663ad735f619cc37d1006

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nd-enum.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    nd-enum (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  nd-enum!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Romain Clavel
+
+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,33 @@
+# ND::Enum
+
+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/nd/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
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nd-enum
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nd-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 the created tag, 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/[USERNAME]/nd-enum.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/nd/enum/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ND
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        include Enumerable
+        extend Forwardable
+
+        def_delegators :all, :size, :length, :[], :empty?, :last, :index
+
+        def each(&block)
+          all.each(&block)
+        end
+
+        def to_h
+          all.map { |value| [value.to_sym, value] }.to_h
+        end
+
+        def [](value)
+          value.is_a?(Integer) ? all[value] : to_h[value.to_sym]
+        end
+
+        # TODO: Warning if not defined
+        # `t(:foo)`
+        # fr:
+        #   table_name:
+        #     attribute:
+        #       base:
+        #         foo: Foo
+        #
+        # or
+        #
+        # `t(:foo, :scope_a)`
+        # fr:
+        #   table_name:
+        #     attribute:
+        #       base:
+        #         foo: Foo
+        #       scope_a:
+        #         foo: Foo A
+        #       scope_b:
+        #         foo: Foo B
+        def t(value, scope = :base)
+          I18n.t(value, scope: "#{model.table_name}.#{attribute}.#{scope}")
+        end
+      end
+    end
+  end
+end

data/lib/nd/enum/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ND
+  module Enum
+    VERSION = '0.1.1'
+  end
+end

data/lib/nd/enum.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'enum/version'
+
+module ND
+  module Enum
+    class << self
+      def nd_enum(db: false, i18n: {}, **configuration)
+        set_options(binding)
+        enum_module = define_module(@options)
+
+        define_db_enum(db, enum_module) if @options[:db]
+
+        const_set(@options[:attribute].to_s.camelize, enum_module)
+      end
+
+      private
+
+      def set_options(caller_binding)
+        @options = method(:nd_enum).parameters.each_with_object({}) do |(_, name), options|
+          options[name.to_sym] = caller_binding.local_variable_get(name)
+        end
+        @options[:attribute], @options[:values] = @options.delete(:configuration).to_a.first
+        @options[:model] = self
+      end
+
+      def define_module(options)
+        Module.new do
+          include ND::Enum::Base
+
+          # Public methods
+
+          define_singleton_method(:all)     { options[:values] }
+
+          # Private methods
+
+          define_singleton_method(:options) { options }
+          options.each_key do |name|
+            define_singleton_method(name) { options[name] }
+          end
+
+          [:options, *options.keys].each do |method_name|
+            singleton_class.class_eval { private method_name.to_sym }
+          end
+
+          # Constants
+
+          options[:values].map do |value|
+            const_set(value.to_s.upcase, value.to_s)
+          end
+        end
+      end
+
+      def define_db_enum(options, enum_module)
+        options = options.is_a?(Hash) ? options : {}
+        enum(@attribute => enum_module.to_h, **options)
+      end
+    end
+  end
+end

data/nd-enum.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/nd/enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'nd-enum'
+  spec.version = ND::Enum::VERSION
+  spec.authors = ['Romain Clavel']
+  spec.email = ['romain@clavel.io']
+
+  spec.summary = 'Powerful enum for Rails models.'
+  spec.homepage = 'https://github.com/rclavel/nd-enum'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rclavel/nd-enum'
+  spec.metadata['changelog_uri'] = 'https://github.com/rclavel/nd-enum/blob/master/CHANGELOG.md'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/nd/enum.rbs

@@ -0,0 +1,6 @@
+module ND
+  module Enum
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nd-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Romain Clavel
@@ -16,7 +16,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nd/enum.rb
+- lib/nd/enum/base.rb
+- lib/nd/enum/version.rb
+- nd-enum.gemspec
+- sig/nd/enum.rbs
 homepage: https://github.com/rclavel/nd-enum
 licenses:
 - MIT