localized_controllers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6048fd7855dcaaddc0b0c6ebd1c009399e3571301e453b5661a314139483bce
+  data.tar.gz: 25ef63b0874e083bf7d56aff9d50d90526f976168b5d0c651ab07c737155a791
+SHA512:
+  metadata.gz: 4b89fb98cb5786ba3cdf1fd0df6dbd9d6c9fd75256a4baa2b9823fd35c1aafe55d30610eff0c217aecd5ae473ebfde14538bd53cd2602ae5cc489f8df95b7461
+  data.tar.gz: 5961bf0932ac5d9f16de219e55e9a743b6dcce90787b3cea19fd1dad6945d89a67ffce7263771d154f1c132e9065a2ae1038ea279e13f25d1b68483621683efe

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,114 @@
+[![Build Status](https://travis-ci.com/hamuyuuki/localized_controllers.svg?branch=main)](https://travis-ci.com/hamuyuuki/localized_controllers)
+[![CI](https://github.com/hamuyuuki/localized_controllers/actions/workflows/ci.yml/badge.svg)](https://github.com/hamuyuuki/localized_controllers/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/22ce36bcfc386745e3b1/maintainability)](https://codeclimate.com/github/hamuyuuki/localized_controllers/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/22ce36bcfc386745e3b1/test_coverage)](https://codeclimate.com/github/hamuyuuki/localized_controllers/test_coverage)
+
+# localized_controllers
+
+`localized_controllers` brings _automagic_ localization to controllers. That's inspired by [Localized Views](https://guides.rubyonrails.org/i18n.html#localized-views) in Rails.
+
+## Advance preparation
+
+`localized_controllers` supports only _Setting the Locale from URL Params_ way to resolve the locale now. Please refer to https://guides.rubyonrails.org/i18n.html#setting-the-locale-from-url-params.
+
+## Getting Started
+
+Install `localized_controllers` at the command prompt:
+
+```sh
+gem install localized_controllers
+```
+
+Or add `localized_controllers` to your Gemfile:
+
+```ruby
+gem "localized_controllers"
+```
+
+## How to use
+
+For example, You have `/(en|ja)/localizable_resources` endpoint and route it to `LocalizableResources#index`.
+
+`config/routes.rb`:
+
+```rb
+Rails
+  .application
+  .routes
+  .draw do
+    scope "(:locale)", locale: /en|ja/ do
+      get "localizable_resources", to: "localizable_resources#index"
+    end
+  end
+```
+
+`app/controllers/localizable_resources_controller.rb`:
+
+```rb
+class LocalizableResourcesController < ApplicationController
+  def index; end
+end
+```
+
+If you'd like to localize `LocalizableResources#index` to `en` locale, You can generate the controller and its views with `rails generate localized_controllers` command. Then you can serve with `LocalizableResourcesEn#index` when `/en/localizable_resources` endpoint is requested.
+
+```sh
+rails generate localized_controllers LocalizableResources en index
+```
+
+`app/controllers/localizable_resources_en_controller.rb`:
+
+```rb
+class LocalizableResourcesEnController < ApplicationController
+  def index; end
+end
+```
+
+`app/views/localizable_resources/index.en.html.erb`:
+
+```html
+This view is the LocalizableResources#index for the en locale.
+```
+
+For more information of `rails generate localized_controllers` command, please see the following:
+
+```sh
+$ rails generate localized_controllers
+Usage:
+  rails generate localized_controllers NAME LOCALE [action action] [options]
+
+Options:
+  [--skip-namespace], [--no-skip-namespace]  # Skip namespace (affects only isolated applications)
+
+Runtime options:
+  -f, [--force]                    # Overwrite files that already exist
+  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
+  -q, [--quiet], [--no-quiet]      # Suppress status output
+  -s, [--skip], [--no-skip]        # Skip files that already exist
+
+Description:
+    Stubs out a new localized controller and its views. Pass the controller name,
+    either CamelCased or under_scored, the locale name and a list of views as
+    arguments.
+
+    To create a localized controller within a module, specify the controller name
+    as a path like 'parent_module/controller_name'.
+
+    This generates a localized controller class in app/controllers and template
+    engine.
+
+Example:
+    `rails generate localized_controllers LocalizableResources en index show`
+
+    LocalizableResourcesEn controller with URLs like /localizable_resources.
+        Controller: app/controllers/localizable_resources_en_controller.rb
+        Views:      app/views/localizable_resources/index.en.html.erb [...]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hamuyuuki/localized_controllers. 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
+
+`localized_controllers` is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# 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 = "LocalizedControllers"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/localized_controllers/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Stubs out a new localized controller and its views. Pass the controller name,
+    either CamelCased or under_scored, the locale name and a list of views as
+    arguments.
+
+    To create a localized controller within a module, specify the controller name
+    as a path like 'parent_module/controller_name'.
+
+    This generates a localized controller class in app/controllers and template
+    engine.
+
+Example:
+    `rails generate localized_controllers LocalizableResources en index show`
+
+    LocalizableResourcesEn controller with URLs like /localizable_resources.
+        Controller: app/controllers/localizable_resources_en_controller.rb
+        Views:      app/views/localizable_resources/index.en.html.erb [...]

data/lib/generators/localized_controllers/localized_controllers_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class LocalizedControllersGenerator < Rails::Generators::NamedBase
+  argument :locale, type: :string
+  argument :actions, type: :array, default: [], banner: "action action"
+
+  source_root File.expand_path("templates", __dir__)
+
+  def create_controller_file
+    template "controller.rb",
+             File.join(
+               "app/controllers",
+               class_path,
+               "#{file_name}_#{locale}_controller.rb"
+             )
+  end
+
+  def create_view_files
+    actions.each do |action|
+      @action = action
+      template "view.html.erb",
+               File.join(
+                 "app/views",
+                 class_path,
+                 file_name,
+                 "#{action}.#{locale}.html.erb"
+               )
+    end
+  end
+end

data/lib/generators/localized_controllers/templates/controller.rb.tt

@@ -0,0 +1,5 @@
+class <%= class_name %><%= locale.camelize %>Controller < ApplicationController
+<% actions.each do |action| -%>
+  def <%= action %>; end
+<% end -%>
+end

data/lib/generators/localized_controllers/templates/view.html.erb.tt

@@ -0,0 +1 @@
+This view is the <%= class_name %>#<%= @action %> for the <%= locale %> locale.

data/lib/localized_controllers.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "active_support/lazy_load_hooks"
+
+ActiveSupport.on_load(:action_controller) do
+  ActionDispatch::Request.prepend(
+    Module.new do
+      def controller_class
+        original_controller_class = super
+
+        if path_parameters[:locale]
+          controller_class_for(
+            "#{params[:controller]}_#{path_parameters[:locale]}"
+          )
+        else
+          original_controller_class
+        end
+      end
+    end
+  )
+  ActionController::Base.prepend(
+    Module.new do
+      def default_render(*args)
+        if params["locale"]
+          render(template: "#{params[:controller]}/#{params[:action]}")
+        else
+          super
+        end
+      end
+    end
+  )
+end

data/lib/localized_controllers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LocalizedControllers
+  VERSION = "0.1.0"
+end

data/lib/tasks/localized_controllers_tasks.rake

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: localized_controllers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hamuyuuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: rubocop-rails
+  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'
+- !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'
+description: Bring automagic localization to controllers.
+email:
+- 13702378+hamuyuuki@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/localized_controllers/USAGE
+- lib/generators/localized_controllers/localized_controllers_generator.rb
+- lib/generators/localized_controllers/templates/controller.rb.tt
+- lib/generators/localized_controllers/templates/view.html.erb.tt
+- lib/localized_controllers.rb
+- lib/localized_controllers/version.rb
+- lib/tasks/localized_controllers_tasks.rake
+homepage: https://github.com/hamuyuuki/localized_controllers
+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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.3
+signing_key: 
+specification_version: 4
+summary: Bring automagic localization to controllers
+test_files: []