acts_as_read_only_i18n_localised 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d49d07db700e026f139a9734fd231b13d8305d86
+  data.tar.gz: 1a3fd6440e06b304458e741a1e6ccb3dca0bf0bd
+SHA512:
+  metadata.gz: 4383f8c270f5ba8a6638968e69efa5b5d2911a78e6c70b174b403da30b51caae2a631cf2399a69b5b5d43e0ffea73a80ad1e8cb92cd600b21c4605ab6b64ba8f
+  data.tar.gz: 7d10db3e855a7f976ae40c4945f83b05ebfb2fdb553cfe93f955f6c5092ba24a343f3306e1953102150792661f14ddadfb8e1bbfa5002ef763ce91ec80d913b3

data/.codeclimate.yml

@@ -0,0 +1,30 @@
+---
+engines:
+  brakeman:
+    enabled: false
+  bundler-audit:
+    enabled: true
+  csslint:
+    enabled: false
+  coffeelint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  eslint:
+    enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- coverage/
+- log/
+- tmp/
+- Rakefile

data/.gitignore

@@ -0,0 +1,14 @@
+/log
+/tmp
+/coverage/
+/spec/tmp
+**.orig
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require db_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.4
+  - 2.3.0
+
+cache: bundler

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# How to contribute to Acts as Read-Only I18n Localised project
+
+## Development Process
+
+All development is to follow the [standard git-flow](http://nvie.com/posts/a-successful-git-branching-model/) process, modified to allow for code-reviews.
+
+See this handy, if ugly, [cheat sheet](http://danielkummer.github.io/git-flow-cheatsheet/).
+
+### Setup
+
+1. Fork this repo into your personal GitHub account
+2. clone your fork to your local development machine
+3. Set this repo as the `upstream` repo `git remote add upstream git@github.com:davesag/acts_as_read_only_i18n_localised.git`
+4. Disallow direct pushing to upstream `git remote set-url --push upstream no_push`
+
+### Working on new features
+
+1. Create a "feature branch" for the change you wish to make via `git flow feature start {feature_name}`. See below for how to name features.
+2. Now work on your changes locally until you are happy the issue is resolved. See below for how to name commit messages.
+3. `git flow feature publish {feature_name}` will push it back up to your fork on GitHub.
+4. Use `git flow feature pull {remote_name} {feature_name}` to bring in any other changes, If other people have also merged changes in, and you can't merge your PR automatically you'll need to `rebase` their changes into your changes and then `--force` push the resulting changes using standard `git` commands.
+5. Use GitHub to raise a Pull Request. Add labels as appropriate. See below for how to name pull requests.
+6. Respond to any comments as appropriate, making changes and `git push` ing further changes as appropriate.
+7. When all comments are dealt and the PR finally gets a :+1: from someone else then merge the PR. _Note we will not be using the `git flow feature finish`_ option as that merges into develop automatically without the option for review. [see this stackexchange for more on that](http://programmers.stackexchange.com/questions/187723/code-review-with-git-flow-and-github).
+8. In your command-line `git checkout develop` then `git pull upstream develop` to get the latest code and `git branch -D feature/{branchname}` to delete the old feature branch.
+
+#### Hotfixes and Support branches
+
+It's basically the same process but use the word `hotfix` or `support` instead of `feature`.  `git flow` knows what to do.
+
+## Naming things
+
+There are various systems, including GitHub itself, which will pick up the issue numbers from commit messages and pull requests and automatically associate them with the issues. It is therefore desirable to use a formal naming scheme for features, commit messages and pull requests.
+
+### Features
+
+Features must be named per the following pattern `{issue number}_{some_descriptive_text}` — so for example, if you are working on issue `#1` with the title "do the thing", call your feature `1_do_the_thing`. Obviously use your common sense to avoid making the feature names too long.
+
+Note this will creating a feature via `git flow` will create a branch called `feature/{issue number}_{some_descriptive_text}`.
+
+### Commit Messages
+
+When commiting something use the `-m` flag to add a short commit message of the format `#{issue number} summary of what you changed`.  So for example if you are working on issue `#1` and you added a method to the `aardvark_controller` you might use the following commit message `"#1 added anteater method to aardvark controller"`
+
+Commit messages ought to be in the past tense.
+
+In general try to group file changes wherever appropriate, so if your controller change also involved updating something in a helper file, the one commit message can happily encompas the changes to both files. The message ought to reflect the main aim of the change.
+
+### Pull Requests
+
+Pull requests must be named as follows `[issue type, #issue number] high level description of change`.  The following Issue Types are recognised
+
+* `Bug Fix` - the change fixes a bug
+* `Feature` - the change adds a new feature (the usual issue type)
+* `Documentation` — The change is a documentation only change
+* `Optimisation` - The change is an optimisation of the code base without any functional changes
+
+If your change does not fit any of these categories, use `Feature`. Likewise if your change is not tied to an issue number you may use `n/a` instead.
+
+So to use the above example your Pull Request would be named `[Feature, #1] added anteater to aardvark`

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    acts_as_read_only_i18n_localised (0.0.1)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (8.2.5)
+    coderay (1.1.1)
+    debug_inspector (0.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_read_only_i18n_localised!
+  binding_of_caller
+  pry
+  pry-byebug
+  pry-remote
+  rake
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dave Sag
+
+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,78 @@
+# Acts as Read-Only I18n Localised
+
+A variant on the `acts_as_localized` theme for when you have static seed data in your system that must be localised.
+
+[![Build Status](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised.svg?branch=master)](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised) [![Code Climate](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised/badges/gpa.svg)](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised)
+
+## Why use it?
+
+1. It's designed for a specific use-case, namely the localisation of your seed data.
+2. It works with the standard Rails I18n system and assumes you already have a lot of your localisation data in `config/locales/*.yml`, or you have your `i18n` stuff already set up in a database.
+3. It's fast and easy.
+
+## Example of use
+
+In `config/locales/categories.en.yml`
+
+    en:
+      categories:
+        fruits:
+          name: Great fresh fruit
+          description: Our fantastic range of seasonal and local fresh fruit will delight you.
+        vegetables:
+          name: Farm fresh veggies
+          description: Our locally grown and freshly harvested veggies are simply delicious.
+        meats:
+          name: Farm-fresh seasonal meat
+          description: >-
+            Loved in life then lightly killed, our meat is locally sourced from small farms
+            that meet our demanding standards.
+  
+In `app/models/category.rb`
+  
+    class Category < ActiveRecord::Base
+      include ActsAsReadOnlyI18nLocalised
+      validates :slug, format: {with: /^[a-z]+[\-?[a-z]*]*$/},
+                       uniqueness: true,
+                       presence: true
+      has_many :products
+      validates_associated :products
+      
+      acts_as_read_only_i18n_localised :name, :description
+    end
+
+This simply generates appropriate `name` and `description` methods along the lines of
+
+    def name
+      key = "#{self.class.name.pluralize}.#{slug}.name".downcase.to_sym
+      return I18n.t(key)
+    end
+
+with the effect that a call to `category.name` will always return the localised name using the standard `I18n` system.
+
+Depending on how your code is configured, `I18n` will raise a `MissingTranslationData` exception if the key does correspond to any data. Exceptions on missing keys is usually turned on in `development` and `test` but not on `staging` or `production`. See The [Rails I18n Guide](http://guides.rubyonrails.org/i18n.html) for more.
+
+## Seeding your database
+
+In `db/seeds.rb` add something like
+
+    require 'i18n'
+
+    I18n.t(:categories).each do |key, data|
+      Category.create(slug: key)
+    end
+
+# Development
+
+## To build the gem
+
+    gem build acts_as_read_only_i18n_localised.gemspec
+
+## To test it
+
+    rspec
+
+or
+
+    rake
+

data/Rakefile

@@ -0,0 +1,9 @@
+# rubocop:disable all
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => [:spec]
+rescue LoadError
+  # ignore
+end
+# rubocop:enable all

data/acts_as_read_only_i18n_localised.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'acts_as_read_only_i18n_localised/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'acts_as_read_only_i18n_localised'
+  s.version       = ActsAsReadOnlyI18nLocalised::VERSION
+  s.authors       = ['Dave Sag']
+  s.email         = ['davesag@gmail.com']
+  s.homepage      = 'http://github.com/davesag/acts_as_read_only_i18n_localised'
+  s.summary       = 'Simple mechanism to allow localised lookups of seed data.'
+  s.description   = 'A way to read localised data in Active Record models'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '> 2.0.0'
+
+  s.add_dependency 'i18n'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'binding_of_caller'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-remote'
+  s.add_development_dependency 'pry-byebug'
+end

data/lib/acts_as_read_only_i18n_localised.rb

@@ -0,0 +1,41 @@
+require 'i18n'
+
+#
+# Use as follows
+# class Thing < ActiveRecord::Base
+#   include ActsAsReadOnlyI18nLocalised
+#   validates :slug, format: {with: /^[a-z]+[\-?[a-z]*]*$/},
+#                    uniqueness: true,
+#                    presence: true
+#   acts_as_read_only_i18n_localised :name
+# end
+#
+# thing = Thing.create(stub: 'test')
+# puts(thing.name)
+#
+module ActsAsReadOnlyI18nLocalised
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  #
+  # Standard Ruby idiom for auto-adding class methods
+  #
+  module ClassMethods
+    def underscore(string)
+      string
+    end
+
+    def acts_as_read_only_i18n_localised(*attributes)
+      attributes.each do |attribute|
+        define_method attribute do
+          I18n.t("#{self.class.name.gsub(/::/, '/')
+                                    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                                    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                                    .tr('-', '_')}.#{send(:slug)}.#{attribute}"
+                 .downcase.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_read_only_i18n_localised/version.rb

@@ -0,0 +1,3 @@
+module ActsAsReadOnlyI18nLocalised
+  VERSION = '0.0.1'.freeze
+end

data/spec/acts_as_read_only_i18n_localised_spec.rb

@@ -0,0 +1,33 @@
+require 'i18n'
+require 'acts_as_read_only_i18n_localised'
+
+class TestModel
+  include ActsAsReadOnlyI18nLocalised
+  attr_reader :slug
+
+  def initialize(options)
+    @slug = options[:slug]
+  end
+
+  acts_as_read_only_i18n_localised :name
+end
+
+describe 'ActsAsReadOnlyI18nLocalised' do
+  let(:model)    { TestModel.new(slug: 'test') }
+  let(:key)      { :'test_model.test.name' }
+  let(:expected) { 'test-result' }
+
+  before :all do
+    I18n.enforce_available_locales = false
+    I18n.locale = :en
+  end
+
+  before :each do
+    allow(I18n).to receive(:t).with(key).and_return(expected)
+  end
+
+  it 'has a name method' do
+    expect(model).to respond_to :name
+    expect(model.name).to eq expected
+  end
+end

data/spec/db_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'pry'
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # allow us to disable verify_partial_doubles on a case by case basis.
+  config.around(:each, verify_stubs: false) do |ex|
+    config.mock_with :rspec do |mocks|
+      mocks.verify_partial_doubles = false
+      ex.run
+      mocks.verify_partial_doubles = true
+    end
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+  # But allow use of `describe` etc regardless.
+  config.expose_dsl_globally = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_read_only_i18n_localised
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Sag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: binding_of_caller
+  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: pry
+  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: pry-remote
+  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: pry-byebug
+  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'
+description: A way to read localised data in Active Record models
+email:
+- davesag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_read_only_i18n_localised.gemspec
+- lib/acts_as_read_only_i18n_localised.rb
+- lib/acts_as_read_only_i18n_localised/version.rb
+- spec/acts_as_read_only_i18n_localised_spec.rb
+- spec/db_helper.rb
+- spec/spec_helper.rb
+homepage: http://github.com/davesag/acts_as_read_only_i18n_localised
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple mechanism to allow localised lookups of seed data.
+test_files: []