puttext-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11e9982df0995678d310dc8d6669db2b9a8cc933
+  data.tar.gz: 898dad4aa2bf916a4c52f6869c663227de7e532c
+SHA512:
+  metadata.gz: 3c3f7262d39854e899fc06a96df569dd7ba33e19339eb7de1d1d3a1e042fe04606697bf3489739dd0624a350681184c05f7e948810476c3f06378120e5200750
+  data.tar.gz: 8b142333f0a41a01acc93abeeec8cf28110f2da2149fa879cedd07c11ebc3b7e08030a027d4313542412a8b3e21e5ef3b6eaec0600d2e25a4b435637cf0c53fe

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,30 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'spec/fixtures/**/*'
+  TargetRubyVersion: 2.0
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/EndOfLine:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/FileName:
+  Exclude:
+    - lib/puttext-rails.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+addons:
+  code_climate:
+    repo_token: 123c6c222f854357832855a68eb7e1e43e7a286dc9cecef556f8729ca062141d
+
+after_success:
+  - bundle exec codeclimate-test-reporter
+
+notifications:
+  email: false
+
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puttext-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    puttext-rails (0.0.1)
+      puttext (>= 0.2.1, < 1)
+      railties (>= 5.0, < 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.1)
+      actionview (= 5.1.1)
+      activesupport (= 5.1.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.1)
+      activesupport (= 5.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.3.0)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubi (1.6.0)
+    i18n (0.8.4)
+    json (2.1.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    puttext (0.2.1)
+      parser (>= 2.4.0.0, < 3.0)
+      unindent
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.1)
+      actionpack (= 5.1.1)
+      activesupport (= 5.1.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    timecop (0.8.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.2.1)
+    unindent (1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 1.0.0)
+  puttext-rails!
+  rake
+  rspec (~> 3.5)
+  rubocop (~> 0.46.0)
+  simplecov
+  timecop
+  unindent
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mantas Norvaiša
+
+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,57 @@
+# puttext-rails
+
+Rails integrations for the puttext gem (https://github/mntnorv/puttext).
+
+What this provides for Rails applications, compared to the plain Ruby gem:
+ - Simplified usage.
+ - Extracts validation error messages from Rails validator and all used gems.
+
+## Installation
+
+Add it to your `Gemfile`:
+```ruby
+group :development do
+  # Other development gems
+  # ...
+
+  gem 'puttext-rails'
+end
+```
+
+## Usage
+
+Just run the `puttext:extract` rake task in your Rails root directory:
+```bash
+$ rake puttext:extract
+```
+
+The translations will be saved in `config/locale/template.pot`. For example:
+```po
+#: ./app/views/hello_world/index.slim:8
+msgid "Hello world!"
+msgstr ""
+```
+
+## Contributing
+
+Before submitting an Issue or Pull Request always check if your issue is already being discussed or if someone has already submitted a pull request with the feature you want to add. Also, before doing bigger changes, it's always good to discuss the changes you're going to make in an Issue.
+
+### Code style
+
+PutText::Rails uses RuboCop (https://github.com/bbatsov/rubocop) to check and enforce code style. Before submitting a pull request, make sure that RuboCop does not find any offenses.
+
+#### Running RuboCop
+
+```bash
+$ bundle exec rubocop
+```
+
+### Testing
+
+PutText::Rails uses RSpec (http://rspec.info/) for testing. Pull requests with Ruby code changes must include RSpec tests that check the new functionality or changed code. Also, make sure that your changes do not break any existing tests.
+
+#### Running RSpec
+
+```bash
+$ bundle exec rspec
+```

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/puttext-rails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'puttext-rails/railtie' if defined?(Rails)
+
+module PutText
+  module Rails
+    MSG_CONTEXT = 'Validation error'.freeze
+  end
+end

data/lib/puttext-rails/extractor.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'puttext'
+require 'rails'
+
+module PutText
+  module Rails
+    class Extractor
+      # Extract string from the Rails project this gem is included in.
+      # @return [POFile] a POFile object containing the extracted strings.
+      def extract
+        puttext_extractor = PutText::Extractor.new
+        po_file = puttext_extractor.extract(root_path)
+
+        errors_file = extract_errors
+        po_file.merge(errors_file)
+
+        po_file
+      end
+
+      private
+
+      def root_path
+        ::Rails.root.relative_path_from(Pathname.new(Dir.pwd))
+      end
+
+      def extract_errors
+        entries = i18n_error_messages.map do |_key, value|
+          create_entry_from_translation(value)
+        end
+
+        POFile.new(entries)
+      end
+
+      def i18n_error_messages
+        i18n_backend = I18n.backend
+
+        unless i18n_backend.is_a? I18n::Backend::Simple
+          raise 'only I18n::Backend::Simple is supported'
+        end
+
+        i18n_backend.available_locales # Force I18n to load translations
+
+        translations = i18n_backend.send(:translations)
+        translations.fetch(I18n.default_locale, {})
+                    .fetch(:errors, {})
+                    .fetch(:messages, {})
+      end
+
+      def create_entry_from_translation(translation)
+        case translation
+        when String
+          POEntry.new(msgctxt: PutText::Rails::MSG_CONTEXT, msgid: translation)
+        when Hash
+          POEntry.new(
+            msgctxt: PutText::Rails::MSG_CONTEXT,
+            msgid: translation[:one] || translation[:other],
+            msgid_plural: translation[:other]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/puttext-rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PutText
+  module Rails
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'tasks/puttext-rails.rake'
+      end
+    end
+  end
+end

data/lib/tasks/puttext-rails.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'puttext-rails/extractor'
+
+namespace :puttext do
+  desc 'Extract strings from source to config/locales/template.pot'
+  task extract: :environment do
+    locales_path = ::Rails.root.join('config/locales')
+    template_path = File.join(locales_path, 'template.pot')
+
+    po_file = PutText::Rails::Extractor.new.extract
+
+    File.open(template_path, 'w') do |f|
+      po_file.write_to(f)
+    end
+  end
+end

data/puttext-rails.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name     = 'puttext-rails'
+  s.version  = '0.0.1'
+  s.date     = Date.today.to_s
+  s.summary  = 'Extract gettext strings from a Rails application'
+  s.authors  = ['Mantas Norvaiša']
+  s.email    = 'mntnorv@gmail.com'
+  s.homepage = 'https://github.com/mntnorv/puttext-rails'
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_runtime_dependency('puttext', '>= 0.2.1', '< 1')
+  s.add_runtime_dependency('railties', '>= 5.0', '< 6')
+
+  # Tools
+  s.add_development_dependency('rake')
+
+  # Testing
+  s.add_development_dependency('rspec', '~> 3.5')
+  s.add_development_dependency('unindent')
+  s.add_development_dependency('timecop')
+
+  # Linters and code policies
+  s.add_development_dependency('rubocop', '~> 0.46.0')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('codeclimate-test-reporter', '~> 1.0.0')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'timecop'
+require 'unindent'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'puttext-rails'

data/spec/unit/extractor_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fileutils'
+require 'puttext-rails/extractor'
+
+describe PutText::Rails::Extractor do
+  describe '#extract' do
+    before do
+      FileUtils.mkdir_p('/tmp/puttext-rails/config/locales')
+
+      allow(Rails).to receive(:root).and_return(
+        Pathname.new('/tmp/puttext-rails')
+      )
+
+      Timecop.freeze(Time.utc(2017))
+      Time.zone = 'UTC'
+    end
+
+    after do
+      Timecop.return
+    end
+
+    let(:extracted_entries) { subject.extract.entries }
+
+    context 'I18n backend is I18n::Backend::Simple' do
+      let(:backend) { I18n::Backend::Simple.new }
+
+      before { allow(I18n).to receive(:backend).and_return(backend) }
+
+      context 'Backend has translations for validation errors' do
+        before do
+          allow(backend).to receive(:translations).and_return(
+            en: {
+              errors: {
+                messages: {
+                  message_1: 'Something is invalid',
+                  message_2: {
+                    one: '1 error occurred',
+                    other: '%{count} errors occurred'
+                  }
+                }
+              }
+            }
+          )
+        end
+
+        it 'returns POFile with the extracted error messages' do
+          expect(extracted_entries).to contain_exactly(
+            PutText::POEntry.new(
+              msgctxt: 'Validation error',
+              msgid: 'Something is invalid'
+            ),
+            PutText::POEntry.new(
+              msgctxt: 'Validation error',
+              msgid: '1 error occurred',
+              msgid_plural: '%{count} errors occurred'
+            )
+          )
+        end
+      end
+
+      context 'Backend doesn\'t have validation error translations' do
+        before { allow(backend).to receive(:translations).and_return({}) }
+
+        it 'returns empty POFile' do
+          expect(extracted_entries).to eq []
+        end
+      end
+    end
+
+    context 'I18n backed is not a I18n::Backend::Simple' do
+      let(:backend) { double('Unsupported backend') }
+
+      before { allow(I18n).to receive(:backend).and_return(backend) }
+
+      it 'raises an error' do
+        expect { subject.extract }.to raise_error(
+          'only I18n::Backend::Simple is supported'
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: puttext-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mantas Norvaiša
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puttext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: unindent
+  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: timecop
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email: mntnorv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/puttext-rails.rb
+- lib/puttext-rails/extractor.rb
+- lib/puttext-rails/railtie.rb
+- lib/tasks/puttext-rails.rake
+- puttext-rails.gemspec
+- spec/spec_helper.rb
+- spec/unit/extractor_spec.rb
+homepage: https://github.com/mntnorv/puttext-rails
+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.2.2
+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: Extract gettext strings from a Rails application
+test_files: []