kakimasu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19f3ecf83f6bda640b5d8465e3ba4b3e3f8fbf32
+  data.tar.gz: c3c2d993b0e079f8aea10a291687c84488155833
+SHA512:
+  metadata.gz: 4f5dc350f79bc2d2552e6ccda603efde4da8d0306d81f9de269373937d732e8e328d773a1381d455af8687b9e781292c9da34b48db3b9cddd01abbb460f8ac66
+  data.tar.gz: 1e33798a2b6bd8cf576bd0cd5e3914eddd52c24746b05519f7eff753697edaa1b878b9c821c6a1371da9219a973973f906a9dd998d2d0a2c4762ab6f50777e7b

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,31 @@
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'kakimasu.gemspec'
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/LineLength:
+  Max: 200
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/**/*'
+    - 'app/**/*'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'config/initializers/i18n.rb'
+
+Metrics/AbcSize:
+  Max: 75
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/PerceivedComplexity:
+  Max: 25
+

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4
+
+cache: bundler
+script: 'bundle exec rspec spec'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at roberts.groza23@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kakimasu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Roberts Groza
+
+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,135 @@
+[![Build Status](https://travis-ci.org/RobertsGroza/kakimasu.svg?branch=master)](https://travis-ci.org/RobertsGroza/kakimasu) [![Coverage Status](https://coveralls.io/repos/github/RobertsGroza/kakimasu/badge.svg?branch=master)](https://coveralls.io/github/RobertsGroza/kakimasu?branch=master)
+
+# Kakimasu
+
+Kakimasu is _Ruby_ gem for easy translation management in _Ruby on Rails_ projects which uses _Redis server_ for translation storage.
+Kakimasu most valuable function is that it can add translations right from your browser. That's right - create translations without suffering. With Kakimasu you can add translations more faster and more effective, and it has even google translate support. You want to use 'lazy lookup' keys? With this gem you can do that with ease from 'key management' view.
+Adding translations are not only function for Kakimasu. You can manage all used keys in project. You can even see just those keys which doesn't have translations in all languages (keys with missing translations). You can easily track your translation progress in project.
+Also for developers this gem has special features - views generating and policy generating for ability to customize views and permissions.
+One of the features is backup - you can save all your translations in backup file and you can restore backup (these functions can be very useful when you migrate project and want to keep your translations).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kakimasu'
+```
+
+I18n should be set up in the project for successful translation
+
+Include Kakimasu in your application controller and for successfull translation  process you have to add ```:set_show_translation_key```:
+```ruby
+class ApplicationController < ActionController::Base
+  include Kakimasu
+  before_action :set_show_translation_key
+end
+```
+
+Edit *default url options* in your application controller to pass 
+show_translation_key param between requests.
+
+```ruby
+def default_url_options
+  { show_translation_key: Thread.current[:show_tranlsation_key] }
+end
+```
+
+If I18n is included in default url options then:
+```ruby
+def default_url_options
+  { locale: I18n.locale, show_translation_key: Thread.current[:show_translation_key] }.merge(super)
+end
+```
+
+Require Kakimasu in your application.coffee
+
+```
+#= require kakimasu
+```
+
+To use stylesheets add this line to your application.scss
+```
+@import "kakimasu";
+```
+
+Path to kakimasu panel is *translations_path*
+
+Link for translator activation should be:
+```
+#For activation
+= link_to t('activate_translation_mode'), { show_translation_key: true }, id: 'activate_translation_mode_button'
+#For deactivation
+= link_to t('deactivate_translation_mode'), show_translation_key: false
+```
+
+
+## Usage
+
+### Configuring views
+
+If you want to customize kakimasu views, you can easily add them to your _app/views_ by typing in console:
+
+```console $ rails generate kakimasu:views ```
+
+### Forms
+
+There is a issue with form default submit buttons because they display span tags as a plain text (thereby javascript can
+not be executed). So if you want to translate buttons like any other element in project they look like this:
+
+```erb
+<%= f.button :button do %>
+  <% t('translation_key') %>
+<% end %> 
+```
+
+## Security
+
+Of course security is very important for this gem. By default translation mode is available just for admin. If you want to customize something. For example give translation permissions to moderator you should overwrite ``` show_translation_key ``` method.
+In moderator case it would look like this:
+
+```ruby
+  def set_show_translation_key
+    Thread.current[:show_translation_key] = nil
+    return unless current_user.try(:moderator?)
+    Thread.current[:show_translation_key] = (params[:show_translation_key] == 'true').presence
+  end
+```
+
+If you want to configure policy then you can generate translation policy file by just typing in console:
+
+```console
+  $ rails generate kakimasu:policy
+```
+
+## Backups
+
+### Create backup
+
+You can easily create backup file with command:
+
+```console $ rails generate kakimasu:backup ```
+
+After backup all translations are stored in file called _.kakimasu_backup.yml_
+
+### Restore translations
+
+Command for restoring translations from the backup file:
+
+```console $ rails generate kakimasu:restore_backup ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Roberts Groza/kakimasu. 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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/kakimasu/home_controller.rb

@@ -0,0 +1,18 @@
+module Kakimasu
+  class HomeController < ::ApplicationController
+    # Include neccessary helpers
+    include SearchTranslationsHelper
+    include CountingHelper
+
+    def index
+      # Check if user has permissions
+      authorize :translation, :index?
+      policy_scope(Translation)
+
+      # Get translation percentage
+      @all_keys_count = countKeys(search_for_translations('all_translation_keys'))
+      @missing_translation_keys_count = countKeys(search_for_translations('missing_translations'))
+      @percentage = translationPercentage(@all_keys_count, @missing_translation_keys_count)
+    end
+  end
+end

data/app/controllers/kakimasu/keys_controller.rb

@@ -0,0 +1,89 @@
+module Kakimasu
+  class KeysController < ::ApplicationController
+    # Include neccessary helpers
+    include SearchTranslationsHelper
+    include GroupingHelper
+    include SearchKeyHelper
+    include PaginationHelper
+
+    before_action :categories
+    before_action :set_keys_category
+
+    def index
+      # Check if user has permissions
+      authorize :translation, :index?
+      policy_scope(Translation)
+
+      set_page_size(5)                              # set number of keys in one page
+      params[:page] = 1 unless params[:page]        # if page number is not stated, then by default it is 1. page
+      @keys = search_for_translations(@category)    # search for used keys
+      @active_tab = 'keys'                          # sets active tab in navigation
+    end
+
+    def create
+      # Authorize user
+      authorize :translation, :create?
+
+      before_key = params[:key]     # Varibale contains key before create method was executed
+
+      # Check if path to translation key is given
+      enable_lazy_lookup unless params[:path].blank?
+
+      # Variable which is true when function saves changes of something.
+      changed = false
+
+      # Save entered translations
+      I18n.available_locales.each do |l|
+        params[l].gsub!("'", "&#39;")     # Substitutes quotes with quotes HTML code.
+
+        # If there is translation which is not equal with old one, then it is saved
+        unless params[l].blank? || I18n.t(params[:key], locale: l) == params[l]
+          changed = true if (I18n.backend.store_translations(l, { params[:key] => params[l] }, escape: false))
+        end
+      end
+      I18n.backend.store_translations(params[:language], { params[:key] => params[:value] }, escape: false) if params[:language]
+
+      # Process ajax process diferently
+      if request.xhr?
+        respond_to do |format|
+          format.js {}
+        end
+      else
+        redirect_to kakimasu_keys_path(keys_category: @category)
+      end
+
+      # If the key is changed then it means there were changes
+      changed = true if before_key != params[:key]
+
+      # Shows result to user
+      if changed
+        flash.notice = t('translation_succesfully_stored')
+      else
+        flash.alert = t('nothing_was_changed')
+      end
+    end
+
+    private
+
+    # All available categories in "key management" view
+    def categories
+      @categories = ['missing_translations', 'all_translation_keys', 'active_record_attribute_translations', 'active_record_model_translations']
+    end
+
+    # Set current category
+    def set_keys_category
+      @category = params[:keys_category] || 'missing_translations'
+    end
+
+    # Enable/disable 'lazy lookup' on key based on checkbox 'unique' value
+    def enable_lazy_lookup
+      if params[:lazy_lookup]
+        lazy_lookup_key(params[:key], params[:path])
+        params[:key] = prefix(params[:path]) + '.' + params[:key] unless params[:key].start_with?(prefix(params[:path]))
+      else
+        remove_lazy_lookup(params[:key], params[:path])
+        params[:key] = params[:key].split('.').last
+      end
+    end
+  end
+end

data/app/controllers/kakimasu/translations_controller.rb

@@ -0,0 +1,37 @@
+module Kakimasu
+  class TranslationsController < ::ApplicationController
+    # Include neccessary helpers
+    include PaginationHelper
+
+    def index
+      # Authorization
+      authorize :translation, :index?
+      policy_scope(Translation)
+
+      @translations = TRANSLATION_STORE                                                  # Gets all translations from redis
+      @grouped_keys = @translations.keys.group_by { |key| key.partition('.').last }      # Groups all translations by key
+      @active_tab = 'translations'                                                       # Sets active tab in navigation
+
+      set_page_size(10)                            # set number of keys in one page
+      params[:page] = 1 unless params[:page]      # if page number is not stated, then by default it is 1. page
+    end
+
+    def create
+      authorize :translation, :create?
+      I18n.available_locales.each do |l|
+        params[l]&.gsub!("'", "&#39;")
+        I18n.backend.store_translations(l, { params[:key] => params[l] }, escape: false) unless params[l].blank?
+      end
+      params[:value]&.gsub!("'", "&#39;")
+      I18n.backend.store_translations(params[:language], { params[:key] => params[:value] }, escape: false) if params[:language]
+
+      if request.xhr?
+        respond_to do |format|
+          format.js {}
+        end
+      else
+        redirect_to :back
+      end
+    end
+  end
+end