locale_kit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cad57dffcc8fc54c538c4fd5e3f0b890e5f4026b
+  data.tar.gz: 330aac41759c4773b76b5df8ca77a66cf1ea4aeb
+SHA512:
+  metadata.gz: 849fad4ac735c566b1391f17a6f5b5fad5b0a9c3963d12a82edec42e923ffa15d783809a8bb2247a9309a3d4363d79e550a962ce26c2d5aeeb1e74bd638156f7
+  data.tar.gz: ec8b1fe11c1884ab3afa6a61c9d30513f59a84c5ebd5370774a37bfa7eeaad4d414ef2c217b43a1dae67a1c5d21dad7eacb120ac9e885f7f74141baf6a0ebc74

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Sho Kusano
+
+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,35 @@
+# LocaleKit
+
+Provides new convention of locales and useful generators for Rails components.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locale_kit'
+```
+
+Download and install by running:
+
+```bash
+$ bundle install
+```
+
+Initialize the `app/locales` directory with:
+
+```bash
+$ ./bin/rails locale_kit:install
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/space-pirates/locale_kit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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,34 @@
+# frozen_string_literal: true
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LocaleKit'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/locale_kit_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/locale_kit .css

data/app/assets/stylesheets/locale_kit/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/locale_kit/application_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class LocaleKit::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/app/helpers/locale_kit/application_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+module LocaleKit::ApplicationHelper
+end

data/app/views/layouts/locale_kit/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Locale kit</title>
+    <%= stylesheet_link_tag    "locale_kit/application", media: "all" %>
+    <%= javascript_include_tag "locale_kit/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+
+    <%= yield %>
+
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+LocaleKit::Engine.routes.draw do
+end

data/lib/generators/locale_kit.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/named_base'
+
+module LocaleKit
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+      private
+
+      def locale_dir
+        Rails.root.join(LocaleKit.config.directory)
+      end
+    end
+  end
+end

data/lib/generators/locale_kit/controller/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Genrate locale files for a your controller
+
+Example:
+    rails generate locale_kit:controller Thing
+
+    This will create:
+        app/locales/controllers/thing/{available_locales}.yml

data/lib/generators/locale_kit/controller/controller_generator.rb

@@ -0,0 +1,31 @@
+require 'generators/locale_kit'
+
+class LocaleKit::Generators::ControllerGenerator < LocaleKit::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument(:actions, type: :array, default: [], banner: 'action action')
+
+  def copy_example_locale_file
+    I18n.available_locales.each do |locale|
+      self.current_locale = locale
+      template('controller.yml', locale_dir.join('controllers', *class_path, file_name, "#{locale}.yml"))
+      template('view.yml', locale_dir.join('views', *class_path, file_name, "#{locale}.yml"))
+    end
+  end
+
+  private
+
+  attr_accessor :current_locale
+
+  def namespaces
+    (class_path + [file_name + '_mailer'])
+  end
+
+  def locale_namespace
+    namespaces.map.with_index(1) { |name, idx| ('  ' * idx) + name + ':' }.join("\n")
+  end
+
+  def action_names
+    actions.map(&:to_s)
+  end
+end

data/lib/generators/locale_kit/controller/templates/controller.yml

@@ -0,0 +1,11 @@
+<%= current_locale %>:
+<%= locale_namespace %>
+<% if action_names.empty? -%>
+<%= "  " * (namespaces.size + 1) %>action_name:
+<%= "  " * (namespaces.size + 2) %>key: "value"
+<%- else -%>
+<% action_names.each do |action_name| -%>
+<%= "  " * (namespaces.size + 1) %><%= action_name %>:
+<%= "  " * (namespaces.size + 2) %>key: "value"
+<% end -%>
+<%- end -%>

data/lib/generators/locale_kit/controller/templates/view.yml

@@ -0,0 +1,11 @@
+<%= current_locale %>:
+<%= locale_namespace %>
+<% if action_names.empty? -%>
+<%= "  " * (namespaces.size + 1) %>view_name:
+<%= "  " * (namespaces.size + 2) %>key: "value"
+<%- else -%>
+<% action_names.each do |action_name| -%>
+<%= "  " * (namespaces.size + 1) %><%= action_name %>:
+<%= "  " * (namespaces.size + 2) %>title: "<%= action_name.classify %>"
+<% end -%>
+<%- end -%>

data/lib/generators/locale_kit/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create locales files to your application
+
+Example:
+    rails generate locale_kit:install
+
+    This will create:
+        app/locales

data/lib/generators/locale_kit/install/install_generator.rb

@@ -0,0 +1,28 @@
+require 'generators/locale_kit'
+
+class LocaleKit::Generators::InstallGenerator < ::Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_locale_dir
+    empty_directory(locale_dir)
+  end
+
+  def copy_example_locale_file
+    I18n.available_locales.each do |locale|
+      self.current_locale = locale
+      template('app.yml', locale_dir.join("#{locale}.yml"))
+    end
+  end
+
+  private
+
+  attr_accessor :current_locale
+
+  def locale_dir
+    Rails.root.join(LocaleKit.config.directory)
+  end
+
+  def app_name
+    Rails.application.class.parent_name.underscore
+  end
+end

data/lib/generators/locale_kit/install/templates/app.yml

@@ -0,0 +1,2 @@
+<%= current_locale %>:
+  application: "<%= app_name %>"

data/lib/generators/locale_kit/mailer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate locales for your mailer
+
+Example:
+    rails generate locale_kit:mailer Thing
+
+    This will create:
+        app/locales/mailers/thing/en.yml

data/lib/generators/locale_kit/mailer/mailer_generator.rb

@@ -0,0 +1,30 @@
+require 'generators/locale_kit'
+
+class LocaleKit::Generators::MailerGenerator < LocaleKit::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument(:actions, type: :array, default: [], banner: 'method method')
+
+  def copy_example_locale_file
+    I18n.available_locales.each do |locale|
+      self.current_locale = locale
+      template('locale.yml', locale_dir.join('mailers', *class_path, file_name, "#{locale}.yml"))
+    end
+  end
+
+  private
+
+  attr_accessor :current_locale
+
+  def namespaces
+    (class_path + [file_name])
+  end
+
+  def locale_namespace
+    namespaces.map.with_index(1) { |name, idx| ('  ' * idx) + name + ':' }.join("\n")
+  end
+
+  def action_names
+    actions.map(&:to_s)
+  end
+end

data/lib/generators/locale_kit/mailer/templates/locale.yml

@@ -0,0 +1,11 @@
+<%= current_locale %>:
+<%= locale_namespace %>
+<% if action_names.empty? -%>
+<%= "  " * (namespaces.size + 1) %>action_name:
+<%= "  " * (namespaces.size + 2) %>subject: "Subject"
+<%- else -%>
+<% action_names.each do |action_name| -%>
+<%= "  " * (namespaces.size + 1) %><%= action_name %>:
+<%= "  " * (namespaces.size + 2) %>subject: "<%= action_name.classify %>"
+<% end -%>
+<%- end -%>

data/lib/generators/locale_kit/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate locales for your model
+
+Example:
+    rails generate locale_kit:model Thing
+
+    This will create:
+        app/locales/models/thing/en.yml

data/lib/generators/locale_kit/model/model_generator.rb

@@ -0,0 +1,38 @@
+require 'generators/locale_kit'
+
+class LocaleKit::Generators::ModelGenerator < LocaleKit::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument(:attributes, type: :array, default: [], banner: 'field:type field:type')
+
+  def copy_example_locale_file
+    I18n.available_locales.each do |locale|
+      self.current_locale = locale
+      template('locale.yml', locale_dir.join('models', *class_path, file_name, "#{locale}.yml"))
+    end
+  end
+
+  private
+
+  attr_accessor :current_locale
+
+  def model_type
+    defined?(ActiveRecord) ? :activerecord : :activemodel
+  end
+
+  def namespaces
+    (class_path + [file_name])
+  end
+
+  def locale_namespace
+    namespaces.map.with_index(1) { |name, idx| ('  ' * idx) + name + ':' }.join("\n")
+  end
+
+  def model_name
+    (class_path + [file_name]).join('/')
+  end
+
+  def attribute_names
+    attributes.map(&:name)
+  end
+end

data/lib/generators/locale_kit/model/templates/locale.yml

@@ -0,0 +1,10 @@
+<%= current_locale %>:
+  <%= model_type %>:
+    models:
+      <%= model_name %>: "<%= file_name.classify %>"
+    attributes:
+      <%= model_name %>:
+        id: "ID"
+<% attribute_names.each do |attr_name| -%>
+        <%= attr_name %>: "<%= attr_name.classify %>"
+<% end -%>

data/lib/generators/locale_kit/override/action_controller.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/rails/controller/controller_generator'
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class ControllerGenerator
+      hook_for :locale_kit, as: :controller, type: :boolean, default: true
+    end
+
+    class ScaffoldControllerGenerator
+      hook_for :locale_kit, as: :controller, type: :boolean, default: true do |invoked|
+        invoke invoked, [controller_name]
+      end
+    end
+  end
+end

data/lib/generators/locale_kit/override/action_mailer.rb

@@ -0,0 +1,9 @@
+require 'rails/generators/mailer/mailer_generator'
+
+module Rails
+  module Generators
+    class MailerGenerator
+      hook_for :locale_kit, as: :mailer, type: :boolean, default: true
+    end
+  end
+end

data/lib/generators/locale_kit/override/active_record.rb

@@ -0,0 +1,9 @@
+require 'rails/generators/active_record/model/model_generator'
+
+module ActiveRecord
+  module Generators
+    class ModelGenerator
+      hook_for :locale_kit, as: :model, type: :boolean, default: true
+    end
+  end
+end

data/lib/locale_kit.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'locale_kit/version'
+require 'locale_kit/config'
+
+module LocaleKit
+  def app
+    Rails.application
+  end
+  module_function :app
+
+  def config
+    @config ||= LocaleKit::Config.instance
+  end
+  module_function :config
+
+  def locales
+    Dir[app.root.join(config.directory, '**', '*.{yml,rb}')]
+  end
+  module_function :locales
+
+  def reload!
+    I18n.load_path = (I18n.load_path + locales).uniq
+    I18n.backend.reload!
+
+    config.logger.try(:info, 'Reloaded locales by LocaleKit')
+  end
+  module_function :reload!
+end
+
+require 'locale_kit/engine' if defined?(Rails)

data/lib/locale_kit/config.rb

@@ -0,0 +1,15 @@
+require 'singleton'
+
+class LocaleKit::Config
+  include Singleton
+
+  def directory
+    @directory ||= File.join('app', 'locales')
+  end
+  attr_writer :directory
+
+  def logger
+    @logger ||= Rails.logger
+  end
+  attr_writer :logger
+end

data/lib/locale_kit/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+class LocaleKit::Engine < ::Rails::Engine
+  isolate_namespace LocaleKit
+
+  config.locale_kit = LocaleKit.config
+
+  generators do |app|
+    Rails::Generators.configure!(app.config.generators)
+    require 'generators/locale_kit/override/action_controller' if defined?(ActionController)
+    require 'generators/locale_kit/override/active_record' if defined?(ActiveRecord)
+    require 'generators/locale_kit/override/action_mailer' if defined?(ActionMailer)
+  end
+
+  config.to_prepare do
+    LocaleKit.reload!
+  end
+end

data/lib/locale_kit/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module LocaleKit
+  VERSION = '0.0.1'.freeze
+end

data/lib/tasks/locale_kit_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :locale_kit do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: locale_kit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sho Kusano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !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: sqlite3
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Improve locales convention of Rails
+email:
+- sho-kusano@space-pirates.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/locale_kit_manifest.js
+- app/assets/stylesheets/locale_kit/application.css
+- app/controllers/locale_kit/application_controller.rb
+- app/helpers/locale_kit/application_helper.rb
+- app/views/layouts/locale_kit/application.html.erb
+- config/routes.rb
+- lib/generators/locale_kit.rb
+- lib/generators/locale_kit/controller/USAGE
+- lib/generators/locale_kit/controller/controller_generator.rb
+- lib/generators/locale_kit/controller/templates/controller.yml
+- lib/generators/locale_kit/controller/templates/view.yml
+- lib/generators/locale_kit/install/USAGE
+- lib/generators/locale_kit/install/install_generator.rb
+- lib/generators/locale_kit/install/templates/app.yml
+- lib/generators/locale_kit/mailer/USAGE
+- lib/generators/locale_kit/mailer/mailer_generator.rb
+- lib/generators/locale_kit/mailer/templates/locale.yml
+- lib/generators/locale_kit/model/USAGE
+- lib/generators/locale_kit/model/model_generator.rb
+- lib/generators/locale_kit/model/templates/locale.yml
+- lib/generators/locale_kit/override/action_controller.rb
+- lib/generators/locale_kit/override/action_mailer.rb
+- lib/generators/locale_kit/override/active_record.rb
+- lib/locale_kit.rb
+- lib/locale_kit/config.rb
+- lib/locale_kit/engine.rb
+- lib/locale_kit/version.rb
+- lib/tasks/locale_kit_tasks.rake
+homepage: https://github.com/space-priates/locale_kit
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Improve locales convention of Rails
+test_files: []