jurou 0.2.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04c2db979a4a93629b8f6c13408b00f7eaae0210
+  data.tar.gz: c908429daec9a6f2899c62a226fc764453026b12
+SHA512:
+  metadata.gz: fdf2e26d7af88716b5120084f04ad3fb049b7030bf6be1c4dfdca1a65c769e8723f602771ae2f5cf6ab730b464471db58f0df88eda6facff3e139a582f6cae1e
+  data.tar.gz: bb0f1be76859e11460504326da72435a86abf8c09ae6d7f9d3c1a882d2a9f0bf65372a32ecb91043711aa2f17cf18e8de950e5554088ec1ef73afb5adf7979c4

data/README.md

@@ -0,0 +1,218 @@
+# jurou / 翻譯蒟蒻
+[![Gem Version](https://badge.fury.io/rb/jurou.svg)](https://badge.fury.io/rb/jurou)
+[![Code Climate](https://codeclimate.com/github/jodeci/jurou/badges/gpa.svg)](https://codeclimate.com/github/jodeci/jurou)
+[![Test Coverage](https://codeclimate.com/github/jodeci/jurou/badges/coverage.svg)](https://codeclimate.com/github/jodeci/jurou/coverage)
+[![Build Status](https://travis-ci.org/jodeci/jurou.svg?branch=master)](https://travis-ci.org/jodeci/jurou)
+
+A collection of i18n related view helpers for Rails. Work in progress.
+
+Lets say we have a model `Book`. `Book.genre` is a pre defined list of book genres, such as `fantasy, detective, romance, history, manga`. 
+
+Most developers stick to English (at least the Latin alphabet) for such values. The thing is, your app more than often requires you to display them as `奇幻, 推理, 羅曼史, 歷史, 漫畫` or whatever your native language. 
+
+Although there's the handy I18n API for localization, turns out this was still a messier process than I imagined. To keep things DRY I put together *jurou* for myself.
+
+## Installation
+
+Tested on Ruby 2.3.1 and Rails 5.
+
+```
+# Gemfile
+gem "jurou"
+```
+
+```
+$ bundle install
+```
+
+Generate the locale yml file. Defaults to your application's `default_locale` if `--locale` not specified.
+
+```
+$ rails generate jurou:install
+$ rails generate jurou:install --locale ja
+```
+
+## Examples
+
+Fill in the details in the generated locale file:
+
+```
+# config/locale/jurou.zh-TW.yml
+zh-TW:
+  jurou:
+    book:
+      genre:
+        fantasy: 奇幻
+        detective: 推理
+        romance: 羅曼史
+        history: 歷史
+        manga: 漫畫
+        
+    app_title: 翻譯蒟蒻
+    
+    page_titles:
+      books:
+        _label: 我的書櫃
+        index: 書籍列表
+        edit: 修改書籍
+      admin/sales:
+        index: 銷售紀錄
+        
+  activerecord:
+    attributes:
+      book:
+        title: 書名
+        author: 作者
+        genre: 類別
+```
+### jr\_collection
+
+Use `jr_collection` in your form template:
+
+```
+# app/views/books/_form.html.slim
+= simple_form_for @book do |f|
+  = f.input :genre, collection: jr_collection(:genre, :book)
+```
+
+*jurou* will then generate the collection hash for the form helper, resulting in the following HTML:
+
+```
+<select>
+  <option value="fantasy">奇幻</option>
+  <option value="detective">推理</option> 
+  <option value="romance">羅曼史</option>
+  <option value="history">歷史</option> 
+  <option value="manga">漫畫</option> 
+</select>
+```
+
+### jr\_attribute
+ 
+`jr_attribute` simply outputs the corresponding translation of the attribute. Shorthand `jr_attr` also available.
+
+```
+jr_attribute :author, :book
+=> "作者"
+```
+
+### jr\_value
+
+`jr_value` is only useful when you need to get the translation for the attribute value itself. 
+
+```
+jr_value :genre, @book.genre, :book
+=> "推理"
+```
+
+### jr\_table\_row, jr\_table\_row\_translate\_value
+
+Or, if you're lazy enough like me, there's also `jr_table_row` and `jr_table_row_translate_value` which takes advantage of `jr_attribute` and `jr_value` to make a quick and dirty table display. Shorthand `jr_row` and `jr_row_val` also available. 
+
+```
+# app/views/books/show.html.slim
+table
+  = jr_table_row :title, @book.title, :book
+  = jr_table_row :author, @book.author, :book
+  = jr_table_row_translate_value :genre, @book.genre, :book
+```
+
+This will produce the following HTML:
+
+```
+<table>
+  <tr>
+    <th>書名</th>
+    <td>神探伽利略</td>
+  </tr>
+  <tr>
+    <th>作者</th>
+    <td>東野圭吾</td>
+  </tr>
+  <tr>
+    <th>類別</th>
+    <td>推理</td>
+  </tr>
+</table>
+```
+
+#### Be more lazy!
+
+For the above helpers, you can omit passing `:book` all together if you are following Rails naming convention:
+
+```
+jr_row :title, @book.title
+=> <tr><th>作者</th><td>神探伽利略</td></tr>
+
+jr_row_val :genre, @book.genre
+=> <tr><th>類別</th><td>推理</td></tr>
+
+jr_attr :author
+=> 作者
+
+jr_value :genre, @book.genre
+=> 推理
+
+jr_collection :genre
+=> { fantasy: "奇幻", detective: "推理", romance: "羅曼史", history: "歷史", manga: "漫畫" }
+```
+
+#### More laziness with shikigami
+
+If you are using *[shikigami](https://github.com/jodeci/shikigami)*, *jurou* will fallback to the `current_object` whenever possible, so you can just write this and be done:
+
+```
+jr_row :title
+=> <tr><th>作者</th><td>神探伽利略</td></tr>
+
+jr_row_val :genre
+=> <tr><th>類別</th><td>推理</td></tr>
+```
+
+### jr\_page\_title 
+
+`jr_page_title` generates the page title based on the current controller and action. It will fallback to your app title when there is no match.
+ 
+```
+# app/views/layout/application.html.slim
+title = jr_page_title
+
+# BooksController#index
+=> "書籍列表 | 翻譯蒟蒻"
+
+# MoviesController#index
+=> "翻譯蒟蒻"
+```
+### jr\_content\_for_page\_title
+
+You can further customize the title with `jr_content_for_page_title`, or `jr_title`
+ for short.
+
+```
+# app/views/books/edit.html.slim
+= jr_content_for_page_title("神探伽利略")
+
+# BooksController#edit
+=> "神探伽利略 | 修改書籍 | 翻譯蒟蒻"
+```
+
+### jr\_simple\_title
+Use `jr_simple_title` when you need to manually get a page title, instead of relying on the black magic of `jr_page_title`. The app title will not be included. Comes in handy when building dropdown menus.
+
+```
+# defaults to the current controller/action
+jr_simple_title
+=> "書籍列表"
+
+# general label for a controller, same as jr_simple_title(:books, :_label)
+jr_simple_title(:books)
+=> "我的書櫃"
+
+# specify controller and action
+jr_simple_title(:books, :index)
+=> "書籍列表"
+
+# controller with namespace
+jr_simple_title("admin/sales", :index)
+=> "銷售管理"
+```

data/lib/generators/jurou/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "rails/generators/base"
+module Jurou
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __FILE__)
+    desc "Creates a locale file for your application"
+    class_option :locale, default: Rails.application.config.i18n.default_locale
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), "templates")
+    end
+
+    def copy_locale
+      copy_file "locale.yml", "config/locales/jurou.#{options[:locale]}.yml"
+    end
+  end
+end

data/lib/generators/jurou/templates/locale.yml

@@ -0,0 +1,23 @@
+#zh-TW:
+#  jurou:
+#    book:
+#      genre:
+#        fantasy: 奇幻
+#        detective: 推理
+#        romance: 羅曼史
+#        history: 歷史
+#        manga: 漫畫
+#
+#    app_title: 翻譯蒟蒻
+#
+#    page_titles:
+#      books:
+#        _label: 我的書櫃
+#        index: 書籍列表
+#
+#  activerecord:
+#    attributes:
+#      book:
+#        title: 書名
+#        author: 作者
+#        genre: 類別

data/lib/jurou.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require "jurou/version"
+require "jurou/engine"
+require "jurou/railtie"
+module Jurou
+end

data/lib/jurou/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "rails/engine"
+require "shikigami"
+module Jurou
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/jurou/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "rails/railtie"
+require "jurou/view_helpers"
+module Jurou
+  class Railtie < ::Rails::Railtie
+    initializer "jurou.view_helpers" do
+      ActiveSupport.on_load(:action_view) { include Jurou::ViewHelpers }
+    end
+  end
+end

data/lib/jurou/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Jurou
+  VERSION = "0.2.13"
+end

data/lib/jurou/view_helpers.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+module Jurou
+  module ViewHelpers
+    def jr_page_title(app_title = "jurou.app_title", divider = "|")
+      "#{@jr_title}#{jr_page_title_by_controller_action(app_title, divider)}"
+    end
+
+    def jr_content_for_page_title(text = nil, divider = "|")
+      @jr_title = "#{text} #{divider} " if text
+      nil
+    end
+    alias jr_title jr_content_for_page_title
+
+    def jr_simple_title(controller = nil, action = nil)
+      unless action
+        if controller
+          action = :_label
+        else
+          controller = controller_path
+          action = action_name
+        end
+      end
+      I18n.t(jr_page_title_translation_key(controller, action))
+    end
+
+    def jr_collection(attribute, model = nil)
+      jr_init_model(model)
+      I18n.t("jurou.#{@_model}.#{attribute}").invert
+    end
+
+    def jr_table_row(attribute, value = nil, model = nil)
+      jr_init_model(model)
+      content_tag :tr do
+        concat content_tag :th, jr_attribute(attribute, @_model)
+        concat content_tag :td, jr_init_value(attribute, value)
+      end
+    end
+    alias jr_row jr_table_row
+
+    def jr_table_row_translate_value(attribute, value = nil, model = nil)
+      jr_init_model(model)
+      content_tag :tr do
+        concat content_tag :th, jr_attribute(attribute, @_model)
+        concat content_tag :td, jr_value(attribute, value, @_model)
+      end
+    end
+    alias jr_row_val jr_table_row_translate_value
+
+    def jr_attribute(attribute, model = nil)
+      jr_init_model(model)
+      I18n.t("activerecord.attributes.#{@_model}.#{attribute}")
+    end
+    alias jr_attr jr_attribute
+
+    def jr_value(attribute, value = nil, model = nil)
+      jr_init_model(model)
+      I18n.t("jurou.#{@_model}.#{attribute}.#{jr_init_value(attribute, value)}")
+    end
+
+    private
+
+    def jr_init_model(model)
+      @_model =
+        if model
+          model
+        elsif params[:id] and current_object
+          current_object.model_name.param_key
+        else
+          controller_name.singularize
+        end
+    end
+
+    def jr_init_value(attribute, value)
+      value || current_object.send(attribute)
+    end
+
+    def jr_page_title_by_controller_action(app_title, divider)
+      "#{t(jr_page_title_translation_key, raise: true)} #{divider} #{t(app_title)}"
+    rescue
+      t(app_title)
+    end
+
+    def jr_page_title_translation_key(controller = controller_path, action = action_name)
+      :"jurou.page_titles.#{controller}.#{action}"
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: jurou
+version: !ruby/object:Gem::Version
+  version: 0.2.13
+platform: ruby
+authors:
+- Tsehau Chao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: shikigami
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: collection of i18n helpers for rails app
+email:
+- jodeci@5xruby.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/jurou/install_generator.rb
+- lib/generators/jurou/templates/locale.yml
+- lib/jurou.rb
+- lib/jurou/engine.rb
+- lib/jurou/railtie.rb
+- lib/jurou/version.rb
+- lib/jurou/view_helpers.rb
+homepage: https://github.com/jodeci/jurou
+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.6
+signing_key: 
+specification_version: 4
+summary: i18n view helpers
+test_files: []