i18n_accessors 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2641f6115e4fbd623fab985ebc188a1881350204
+  data.tar.gz: 24a1d8811112f7a4c449eecd8c0ea44e7e41e972
+SHA512:
+  metadata.gz: 1e2ee6e8e13756ea930fffb422c65d267c018650f2fdeeca67d8703355b199397df0c5d97d13a252093ca0afd47432b14c232a5dbc3d3988fc90bfda6620c5ce
+  data.tar.gz: ac83bff33d37df96709c92f2658c27fdc8852851797128ae3747a4132aeb62d92999ac2749364bcdc86d1fdc6e7546aa414c256c46704590b79a3ef783fc2899

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at chris@dejimata.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n_accessors.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    i18n_accessors (0.1.0)
+      i18n (>= 0.6.10, < 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    i18n (0.8.1)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  i18n_accessors!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Salzberg
+
+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,105 @@
+# I18nAccessors
+
+[![Gem Version](https://badge.fury.io/rb/i18n_accessors.svg)][gem]
+[![Build Status](https://travis-ci.org/shioyama/i18n_accessors.svg?branch=master)][travis]
+
+[gem]: https://rubygems.org/gems/i18n_accessors
+[travis]: https://travis-ci.org/shioyama/i18n_accessors
+
+Define locale accessors for your translated attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_accessors', '~> 0.1.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_accessors
+
+## Usage
+
+### Accessor Methods
+
+To define a set of accessors for a translated attribute of the form
+`<attribute>_<locale>`, include an instance of the `I18nAccessors::Methods`
+class in your model with translated attribute names as arguments:
+
+```ruby
+class Post
+
+  def title
+    # ...
+  end
+
+  def title?
+    # ...
+  end
+
+  def title=(title)
+    # ...
+  end 
+
+  include I18nAccessors::Methods.new(:title)
+end
+```
+By default, `I18n.available_locales` will be used to determine which locales to
+define accessors for. So if `I18n.available_locales` is `[:en, :fr]`, then this
+will define methods: `title_en`, `title_en?`, `title_en=`, `title_fr`,
+`title_fr?` and `title_fr=`. Each of these methods is an alias to `title` (or
+`title?`, or `title=`) with `I18n.locale` changed to the locale in the suffix.
+
+If you want to specify explicitly which locales to define accessors for, pass
+the locales as an option with the `locales` key to `new` when creating the
+module:
+
+```ruby
+def Post
+
+  # ...
+
+  include I18nAccessors::Methods.new(:title, :content, locales: [:en, :fr])
+end
+```
+
+This will define accessor methods for both `title` and `content`, in both
+English (`en`) and French (`fr`).
+
+### Method Missing
+
+`I18nAccessors::Missing` does a similar thing, but using `method_missing` to
+respond to messages of the form `<attribute>_<locale>`. This is generally
+slower (due to how `method_missing` works), but can be used to handle *any* locale:
+
+```ruby
+class Post
+
+  # ...
+
+  include I18nAccessors::Missing.new(:title, :content)
+end
+```
+
+No options are accepted to the constructor for this class.
+
+## 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 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/shioyama/i18n_accessors. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/i18n_accessors.rb

@@ -0,0 +1,19 @@
+require "i18n_accessors/version"
+require "i18n_accessors/methods"
+require "i18n_accessors/missing"
+
+module I18nAccessors
+  class << self
+    # Return normalized locale
+    # @param [String,Symbol] locale
+    # @return [String] Normalized locale
+    # @example
+    #   I18nAccessors.normalize_locale(:ja)
+    #   #=> "ja"
+    #   I18nAccessors.normalize_locale("pt-BR")
+    #   #=> "pt_br"
+    def normalize_locale(locale = I18n.locale)
+      "#{locale.to_s.downcase.sub("-", "_")}".freeze
+    end
+  end
+end

data/lib/i18n_accessors/methods.rb

@@ -0,0 +1,49 @@
+# frozen-string-literal: true
+module I18nAccessors
+=begin
+
+Defines methods for a set of locales to access translated attributes in those
+locales directly with a method call, using a suffix including the locale:
+
+  article.title_pt_br
+
+If no locales are passed as an option to the initializer,
++I18n.available_locales+ will be used by default.
+
+@example
+  class Post
+    def title
+      "title in #{I18n.locale}"
+    end
+    include I18nAccessors::Methods.new("title", locales: [:en, :fr])
+  end
+
+  I18n.locale = :en
+  post = Post.new
+  post.title
+  #=> "title in en"
+  post.title_fr
+  #=> "title in fr"
+
+=end
+  class Methods < Module
+    # @param [String] One or more attributes
+    # @param [Array<Symbol>] Locales
+    def initialize(*attributes, locales: I18n.available_locales)
+      attributes.each do |attribute|
+        locales.each do |locale|
+          normalized_locale = I18nAccessors.normalize_locale(locale)
+          define_method "#{attribute}_#{normalized_locale}" do |*args|
+            I18n.with_locale(locale) { send(attribute, *args) }
+          end
+          define_method "#{attribute}_#{normalized_locale}?" do |*args|
+            I18n.with_locale(locale) { send("#{attribute}?", *args) }
+          end
+          define_method "#{attribute}_#{normalized_locale}=" do |value, *args|
+            I18n.with_locale(locale) { send("#{attribute}=", value, *args) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n_accessors/missing.rb

@@ -0,0 +1,49 @@
+module I18nAccessors
+=begin
+
+Defines +method_missing+ and +respond_to_missing?+ methods for a set of
+attributes such that a method call using a locale accessor, like:
+
+  article.title_pt_br
+
+will return the value of +article.title+ with the locale set to +pt-BR+ around
+the method call.
+
+@example Using missing on a plain old ruby class
+  class Post
+    def title
+      "title in #{I18n.locale}"
+    end
+    include I18nAccessors::Missing.new("title")
+  end
+
+  I18n.locale = :en
+  post = Post.new
+  post.title
+  #=> "title in en"
+  post.title_fr
+  #=> "title in fr"
+
+=end
+  class Missing < Module
+    # @param [String] One or more attributes
+    def initialize(*attributes)
+      method_name_regex = /\A(#{attributes.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+
+      define_method :method_missing do |method_name, *arguments, &block|
+        if method_name =~ method_name_regex
+          attribute = $1.to_sym
+          locale, suffix = $2.split('_'.freeze)
+          locale = "#{locale}-#{suffix.upcase}".freeze if suffix
+          I18n.with_locale(locale) { public_send("#{attribute}#{$4}".freeze, *arguments) }
+        else
+          super(method_name, *arguments, &block)
+        end
+      end
+
+      define_method :respond_to_missing? do |method_name, include_private = false|
+        (method_name =~ method_name_regex) || super(method_name, include_private)
+      end
+    end
+  end
+end

data/lib/i18n_accessors/version.rb

@@ -0,0 +1,3 @@
+module I18nAccessors
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: i18n_accessors
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- chris@dejimata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/i18n_accessors.rb
+- lib/i18n_accessors/methods.rb
+- lib/i18n_accessors/missing.rb
+- lib/i18n_accessors/version.rb
+homepage: https://github.com/shioyama/i18n_accessors
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Define locale-specific attribute accessors.
+test_files: []