ar_enum_i18n 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b913f0bba7a9acf91651b744bf5f27fa4122690372fc934e0acc43b4373da050
4
+ data.tar.gz: '05505368de0f8608a79b09d74eb46c704bebcee99480084a501c82df4caa35d9'
5
+ SHA512:
6
+ metadata.gz: 47360c4ba8984282d4840501e7066bd540f0a2d48c0c5a93cfdf6d4a1806e8389b24d7671306a54384c61520451e75f6ff27426a44243b6923766d5cf03d325b
7
+ data.tar.gz: 2e120e8b700c139b79d70454be6b3b1cb8dfa7c9eef6a5702d42cd7072e3e30f2b519c3194f80dbfc5f024a8016fda4c4f9d67829a4758e6f86506982f51133c
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,2 @@
1
+ inherit_from: .rubocop_todo.yml
2
+
@@ -0,0 +1,80 @@
1
+ # This configuration was generated by
2
+ # `rubocop --auto-gen-config`
3
+ # on 2018-03-08 16:14:30 +0100 using RuboCop version 0.52.1.
4
+ # The point is for the user to remove these configuration records
5
+ # one by one as the offenses are removed from the code base.
6
+ # Note that changes in the inspected code, or installation of new
7
+ # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # Offense count: 1
10
+ # Configuration parameters: CountComments.
11
+ Metrics/MethodLength:
12
+ Max: 12
13
+
14
+ # Offense count: 1
15
+ # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
16
+ # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
17
+ Naming/FileName:
18
+ Exclude:
19
+ - 'lib/ar-enum-i18n.rb'
20
+
21
+ # Offense count: 2
22
+ Style/Documentation:
23
+ Exclude:
24
+ - 'spec/**/*'
25
+ - 'test/**/*'
26
+ - 'lib/ar_enum_i18n.rb'
27
+
28
+ # Offense count: 1
29
+ # Cop supports --auto-correct.
30
+ Style/Encoding:
31
+ Exclude:
32
+ - 'ar_enum_i18n.gemspec'
33
+
34
+ # Offense count: 1
35
+ # Cop supports --auto-correct.
36
+ # Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
37
+ # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
38
+ Style/HashSyntax:
39
+ Exclude:
40
+ - 'Rakefile'
41
+
42
+ # Offense count: 1
43
+ # Cop supports --auto-correct.
44
+ Style/MutableConstant:
45
+ Exclude:
46
+ - 'lib/ar_enum_i18n/version.rb'
47
+
48
+ # Offense count: 2
49
+ # Cop supports --auto-correct.
50
+ # Configuration parameters: PreferredDelimiters.
51
+ Style/PercentLiteralDelimiters:
52
+ Exclude:
53
+ - 'ar_enum_i18n.gemspec'
54
+
55
+ # Offense count: 31
56
+ # Cop supports --auto-correct.
57
+ # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
58
+ # SupportedStyles: single_quotes, double_quotes
59
+ Style/StringLiterals:
60
+ Exclude:
61
+ - 'Gemfile'
62
+ - 'Rakefile'
63
+ - 'ar_enum_i18n.gemspec'
64
+ - 'bin/console'
65
+ - 'lib/ar_enum_i18n.rb'
66
+ - 'lib/ar_enum_i18n/version.rb'
67
+ - 'spec/ar_enum_i18n_spec.rb'
68
+ - 'spec/spec_helper.rb'
69
+
70
+ # Offense count: 2
71
+ # Cop supports --auto-correct.
72
+ Style/UnneededPercentQ:
73
+ Exclude:
74
+ - 'ar_enum_i18n.gemspec'
75
+
76
+ # Offense count: 1
77
+ # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
78
+ # URISchemes: http, https
79
+ Metrics/LineLength:
80
+ Max: 90
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.5.0
5
+ before_install: gem install bundler -v 1.16.1
@@ -0,0 +1,5 @@
1
+ # CHANGELOG
2
+
3
+ ### Version 0.1.0
4
+
5
+ Initial release with basic i18n methods
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at info@andreadalponte.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in ar_enum_i18n.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Andrea Dal Ponte
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,86 @@
1
+ # ActiveRecord Enum I18n
2
+
3
+ ActiveRecord Enum internationalizations utils gem
4
+
5
+ ## Roadmap / TODO
6
+
7
+ - [ ] Better documentation
8
+ - [ ] Test coverage
9
+ - [ ] Gem release
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ ```ruby
16
+ gem 'ar_enum_i18n', '~> 0.1.0'
17
+ ```
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install ar_enum_i18n
26
+
27
+ ## Usage
28
+
29
+ ```ruby
30
+ class User < ActiveRecord::Base
31
+ include ArEnumI18n
32
+
33
+ enum status: %i[active]
34
+ enum_i18n :status
35
+ end
36
+ ```
37
+
38
+ ## Instance Methods
39
+
40
+ ### human_#{enum_field}
41
+
42
+ > Return the translated enum value. Equivalent to:
43
+
44
+ ```ruby
45
+ I18n.t [:activerecord, :enum, User.name.underscore, enum_field, enum_value].join('.'),
46
+ default: enum_value.to_s.humanize
47
+ ```
48
+
49
+ ## Class Methods
50
+
51
+ ### enum_i18n(*args)
52
+
53
+ > Define i18n methods for one or more enum fields.
54
+
55
+ ```ruby
56
+ class User < ActiveRecord::Base
57
+ include ArEnumI18n
58
+
59
+ enum status: %i[active archived]
60
+ enum alarm_level: %i[none warning dander]
61
+
62
+ enum_i18n :status, :alarm_level
63
+ end
64
+ ```
65
+
66
+ ### #{key}_enum
67
+
68
+ > Return an array with the `['enum translated label', 'enum value']` for each enum value.
69
+
70
+ ## Development
71
+
72
+ 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.
73
+
74
+ 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).
75
+
76
+ ## Contributing
77
+
78
+ Bug reports and pull requests are welcome on GitHub at https://github.com/dalpo/ar_enum_i18n. 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.
79
+
80
+ ## License
81
+
82
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
83
+
84
+ ## Code of Conduct
85
+
86
+ Everyone interacting in the Ar::Enum::I18n project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dalpo/ar_enum_i18n/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+
3
+ lib = File.expand_path("../lib", __FILE__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+ require "ar_enum_i18n/version"
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = "ar_enum_i18n"
9
+ spec.version = ArEnumI18n::VERSION
10
+ spec.authors = ["Andrea Dal Ponte"]
11
+ spec.email = ["info@andreadalponte.com"]
12
+
13
+ spec.summary = %q{ActiveRecord Enum I18n support}
14
+ spec.description = %q{ActiveRecord Enum I18n support}
15
+ spec.homepage = "https://github.com/dalpo/ar_enum_i18n"
16
+ spec.license = "MIT"
17
+
18
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
19
+ f.match(%r{^(test|spec|features)/})
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.15"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec", "~> 3.0"
28
+ spec.add_development_dependency "rubocop", "~> 0.50"
29
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "ar_enum_i18n"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1 @@
1
+ require 'ar_enum_i18n'
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ArEnumI18n
4
+ class Error < StandardError; end
5
+
6
+ def self.included(klass)
7
+ klass.instance_eval do
8
+ extend ::ArEnumI18n::ClassMethods
9
+ end
10
+ end
11
+
12
+ module ClassMethods
13
+ def translate_enum_i18n(key, enum_value)
14
+ return nil if enum_value.blank?
15
+ I18n.t [:activerecord, :enum, name.underscore, key, enum_value].join('.'),
16
+ default: enum_value.to_s.humanize
17
+ end
18
+
19
+ def initialize_enum_i18n(key)
20
+ method_name = :"human_#{key}"
21
+ pluralized_key = key.to_s.pluralize
22
+
23
+ define_singleton_method method_name do |enum_value|
24
+ translate_enum_i18n(key, enum_value)
25
+ end
26
+
27
+ # The first argument indicate if the enum should countain
28
+ # integer or string value into the array
29
+ define_singleton_method :"#{key}_enum" do |*args|
30
+ with_integer_values = args[0] == true
31
+ enum_definition = send(pluralized_key)
32
+
33
+ enum_definition.keys.map do |value|
34
+ [
35
+ send(method_name, value),
36
+ with_integer_values ? enum_definition[value] : value
37
+ ]
38
+ end
39
+ end
40
+
41
+ define_method method_name do
42
+ self.class.send method_name, public_send(key)
43
+ end
44
+ end
45
+
46
+ def enum_i18n?(key)
47
+ respond_to?(:"human_#{key}")
48
+ end
49
+
50
+ def enum_i18n(*args)
51
+ args.each do |key|
52
+ raise ArEnumI18n::Error, "Already initialized enum_i18n #{key}" if enum_i18n?(key)
53
+ Rails.logger.debug "Defining i18n enum methods for #{name}##{key}"
54
+ initialize_enum_i18n(key)
55
+ end
56
+ end
57
+ end
58
+ end
59
+
60
+ require "ar_enum_i18n/version"
@@ -0,0 +1,3 @@
1
+ module ArEnumI18n
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,117 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ar_enum_i18n
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrea Dal Ponte
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-06-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.50'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.50'
69
+ description: ActiveRecord Enum I18n support
70
+ email:
71
+ - info@andreadalponte.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".rubocop.yml"
79
+ - ".rubocop_todo.yml"
80
+ - ".travis.yml"
81
+ - CHANGELOG.md
82
+ - CODE_OF_CONDUCT.md
83
+ - Gemfile
84
+ - LICENSE.txt
85
+ - README.md
86
+ - Rakefile
87
+ - ar_enum_i18n.gemspec
88
+ - bin/console
89
+ - bin/setup
90
+ - lib/ar-enum-i18n.rb
91
+ - lib/ar_enum_i18n.rb
92
+ - lib/ar_enum_i18n/version.rb
93
+ homepage: https://github.com/dalpo/ar_enum_i18n
94
+ licenses:
95
+ - MIT
96
+ metadata: {}
97
+ post_install_message:
98
+ rdoc_options: []
99
+ require_paths:
100
+ - lib
101
+ required_ruby_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: '0'
106
+ required_rubygems_version: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ requirements: []
112
+ rubyforge_project:
113
+ rubygems_version: 2.7.6
114
+ signing_key:
115
+ specification_version: 4
116
+ summary: ActiveRecord Enum I18n support
117
+ test_files: []