seielit-i18n_goodies 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0553dd6b51e099552dc8b165f9e788938c2804ac
+  data.tar.gz: c28ddb22e000739585735ab1a14640966b9e61ac
+SHA512:
+  metadata.gz: f0860fa6c666dfb45b772a531c36d27a91b1a17b8956d9dd67c313bb400f0f0297b4813aca117a45ec51d56264ede755f920f45db36e897b6b4b9b2321670733
+  data.tar.gz: 02bfd99348c47ef73b9f6c0775c837c56d65660ae677bfff60f92bc8fc0d28362e085c0ed112557e3d8e96b7a19900276bde81798845409242f492ab1aa84308

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,161 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - '**/tmp/**/*'
+    - '**/script/**/*'
+    - Rakefile
+    - Gemfile
+  UseCache: true
+  TargetRubyVersion: 2.6
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/AsciiComments:
+  Enabled: false
+
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true
+  MinSize: 4
+
+StringLiterals:
+  Enabled: false
+
+FormatString:
+  EnforcedStyle: percent
+
+MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+RedundantSelf:
+  Enabled: false
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+LineLength:
+  Max: 110
+
+MethodLength:
+  Max: 35
+
+EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+PerceivedComplexity:
+  Max: 7
+
+BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+    - let
+    - let!
+    - html
+    - git_source
+    - json
+    - map
+    - map!
+    - modal
+    - reject!
+    - select!
+    - sequence
+    - specify
+    - subject
+    - watch
+  ProceduralMethods:
+    - build
+    - content_tag
+    - each
+    - find_or_initialize_by
+    - find_or_create_by
+    - new
+    - tag
+    - tap
+
+AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+CollectionMethods:
+  PreferredMethods:
+    inject: 'reduce'
+    detect: 'detect'
+
+ArrayJoin:
+  Enabled: false
+
+# AlignHash:
+#   EnforcedColonStyle: key
+
+CommentAnnotation:
+  Keywords:
+    - DRYME
+    - FIXME
+    - HACK
+    - HACKAROUND
+    - OPTIMIZE
+    - OPTIMIZEME
+    - REVIEW
+    - TBD
+    - TODO
+    - WORKAROUND
+
+DotPosition:
+  EnforcedStyle: trailing
+
+Lambda:
+  Enabled: false
+
+AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+ClassLength:
+  Max: 160
+
+CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: false
+
+# improve in a newer version
+AbcSize:
+  Max: 27
+
+RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: false
+
+AsciiComments:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.axlsx'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2017-06-20
+
+* extracted from AIEPBA Comenius

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 icarrera@seiel.com.ar. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in i18n_goodies.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    seielit-i18n_goodies (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  seielit-i18n_goodies!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ignacio Carrera
+
+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,55 @@
+# I18nGoodies
+
+Adds convenience methods to ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_goodies',
+  git: 'https://code.seiel.com.ar/seiel/i18n_goodies',
+  ref: 'v1.0.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+…
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install i18n_goodies
+…
+```
+
+## Usage
+
+In your `application_model.rb`:
+
+```ruby
+include Seiel::I18nGoodies
+```
+
+TODO: specify each method.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/i18n_goodies.> 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 I18nGoodies project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/i18n_goodies/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i18n_goodies"
+
+# 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/i18n_goodies.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'seiel/i18n_goodies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seielit-i18n_goodies'
+  spec.version       = I18nGoodies::VERSION
+  spec.authors       = ['Ignacio Carrera']
+  spec.email         = ['icarrera@seiel.com.ar']
+
+  spec.summary       = 'Adds convenience methods to ActiveRecord models.'
+  spec.homepage      = 'https://code.seiel.com.ar/seiel/i18n_goodies'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # 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 # rubocop:disable ExpandPathArguments
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',
+    '~> 2.0'
+  spec.add_development_dependency 'minitest',
+    '~> 5.0'
+  spec.add_development_dependency 'rake',
+    '~> 10.0'
+end

data/lib/i18n_goodies.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "seiel/i18n_goodies/version"
+require "seiel/i18n_goodies"
+
+module Seiel
+end

data/lib/seiel/i18n_goodies.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Seiel
+  # Extend Rails' #i18n_scope method to return the long path for i18n scopes
+  module I18nGoodies
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+      extend Enums
+    end
+
+    def i18n_scope(*args)
+      self.class.i18n_scope(*args)
+    end
+
+    def i18n(key, *args, **kws)
+      key = send(key) if key.is_a? Symbol
+
+      self.class.i18n(key, *args, **kws)
+    end
+
+    def error_message(key, data = {})
+      i18n key.to_s, :errors, :messages, data, model: true
+    end
+
+    module ClassMethods
+      def i18n_scope(*args)
+        if args.empty?
+          super
+        else
+          opts = args.extract_options!
+          (
+            [
+              super(),
+              args.shift,
+              (opts[:skip_models] ? nil : :models),
+              model_name.i18n_key
+            ].compact + args.compact
+          ).map(&:to_s)
+        end
+      end
+
+      def i18n(key, *args, **kws)
+        if kws[:model]
+          kws[:skip_models] = false
+          kws[:skip_enums] = true
+        end
+
+        kws[:skip_models] = true unless kws.key?(:skip_models)
+        skip_enums = kws.delete(:skip_enums)
+
+        args.unshift :enums unless skip_enums
+
+        data = {}
+        data.merge! args.pop if args.last.is_a?(Hash)
+        data[:scope] = i18n_scope(*args, **kws)
+
+        I18n.t key,
+          data
+      end
+
+      #
+      # Adapts enums with i18n conventions for statuses
+      #
+      # @param [Hash] definitions Same as Rails' own
+      #
+      def status_enum(definitions)
+        enum definitions,
+          namespace: :statuses,
+          namespace_skip_models: false,
+          default_kind: :captions
+      end
+
+      #
+      # Decorate Rails' #enum with i18n methods.
+      #
+      #   * `Model.plural_enums.i18n`: returns an array of arrays like `['Caption', 'string', 0]`
+      #   * `Model.plural_enums.for_select`: returns an array useful for an html select
+      #
+      # @param [Hash] definitions Same as Rails' own
+      # @param [#to_s] namespace: useful for i18n scopes; default :enums
+      # @param [bool] namespace_skip_models: useful for i18n scopes; default true
+      # @param [#to_s] default_kind: useful for i18n scopes; default nil
+      #
+      def enum(definitions, namespace: :enums, namespace_skip_models: true, default_kind: nil)
+        super(definitions)
+
+        klass = self
+        definitions.each do |name, _|
+          meth = name.to_s.pluralize
+          feature = 'i18n_extensions'
+          with = "#{meth}_with_#{feature}"
+          without = "#{meth}_without_#{feature}"
+          klass.singleton_class.send(:define_method, with) {
+            value = send(without).try :dup
+
+            unless value.nil?
+              value.extend Enums::ClassExtensions
+              value._model = self
+              value._enum = name
+              value._namespace = namespace
+              value._namespace_skip_models = namespace_skip_models
+              value._default_kind = default_kind
+              value
+            end
+          }
+
+          # FIXME: buscar la manera de utilizar #prepend
+          eigenclass = klass.singleton_class
+          eigenclass.send(:alias_method, without, meth)
+          eigenclass.send(:alias_method, meth, with)
+
+          define_method(name) {
+            value = super().try :dup
+
+            unless value.nil?
+              value.extend Enums::Extensions
+              value._model = self
+              value._enum = name
+              value._namespace = namespace
+              value._namespace_skip_models = namespace_skip_models
+              value._default_kind = default_kind
+              value
+            end
+          }
+        end
+      end
+    end
+
+    # Extend ActiveRecord's #enum to extend values with i18n helpers
+    module Enums
+      module Extensions
+        attr_accessor :_model,
+          :_enum,
+          :_namespace,
+          :_namespace_skip_models,
+          :_default_kind
+
+        def i18n(kind = nil, **kws)
+          kind ||= _default_kind
+          kws[:scope] = _model.i18n_scope _namespace,
+            kind,
+            _enum,
+            skip_models: _namespace_skip_models
+
+          I18n.t self,
+            kws
+        end
+      end
+
+      module ClassExtensions
+        attr_accessor :_model,
+          :_enum,
+          :_namespace,
+          :_namespace_skip_models,
+          :_default_kind
+
+        def i18n(kind = nil)
+          kind ||= _default_kind
+          map { |code, id|
+            [
+              I18n.t(
+                code,
+                scope: _model.i18n_scope(_namespace, kind, _enum, skip_models: _namespace_skip_models)
+              ),
+              code,
+              id
+            ]
+          }
+        end
+
+        def for_select(kind = nil)
+          kind ||= _default_kind
+
+          map { |code, _|
+            data = %i[classes iconos captions].map { |key|
+              {
+                key => I18n.t(
+                  code,
+                  scope: _model.i18n_scope(_namespace, key, _enum, skip_models: _namespace_skip_models),
+                  default: ''
+                )
+              }
+            }.reduce(:merge)
+            data.reject! { |_, str| str.blank? }
+
+            [
+              I18n.t(
+                code,
+                scope: _model.i18n_scope(_namespace, kind, _enum, skip_models: _namespace_skip_models)
+              ),
+              code,
+              data
+            ].compact
+          }
+        end
+      end
+    end
+  end
+end

data/lib/seiel/i18n_goodies/version.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: seielit-i18n_goodies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ignacio Carrera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: 
+email:
+- icarrera@seiel.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n_goodies.gemspec
+- lib/i18n_goodies.rb
+- lib/seiel/i18n_goodies.rb
+- lib/seiel/i18n_goodies/version.rb
+homepage: https://code.seiel.com.ar/seiel/i18n_goodies
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://code.seiel.com.ar/seiel/i18n_goodies
+  source_code_uri: https://code.seiel.com.ar/seiel/i18n_goodies
+  changelog_uri: https://code.seiel.com.ar/seiel/i18n_goodies
+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.8
+signing_key: 
+specification_version: 4
+summary: Adds convenience methods to ActiveRecord models.
+test_files: []