chivy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1603bd0a85a275283a45ce56b63e9bb845e2a26b
+  data.tar.gz: 3e293b627cf02cddf8b271e59f518d6eb1ceeac9
+SHA512:
+  metadata.gz: cb0d8aa1ff2d7d738cfb5b20502384a2918395eccedc40e33aebd03b13fee696abd0f19586ce8c65f740234f9b823a366d2e99af98962aad5aa18a0c69a026b4
+  data.tar.gz: 287d6a198e851d116d81cb04dd07d99e3514010031068dedae5066e46d99ad760d740a0fa48a6b21eb714aee9bf8cf9fabb21fd5444c2f2ef1e5cd842b53b4eb

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in woro.gemspec
+gemspec
+
+group :test do
+  gem 'aruba'
+  gem "rspec"
+  gem "rspec-nc"
+  gem 'fakefs'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Senff
+
+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,58 @@
+# Chivy
+
+Offers a quick way of analyzing language YAML-files and to add missing translation keys from the CLI.
+
+[![Gem Version](https://img.shields.io/gem/v/chivy.svg)](https://rubygems.org/gems/woro)
+[![Gem Downloads](https://img.shields.io/gem/dt/chivy.svg)](https://rubygems.org/gems/woro)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/dahie/chivy)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'chivy', require: false
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install chivy
+```
+
+## Usage
+
+```shell
+$ chivy list config/locales/
+```
+
+Will search in the directory `config/locales` for all translation yaml-files by the schema "<name>.<locale>.yml" and will output a list of the minimal changeset between both translations.
+
+## Testing
+
+The project classes are tested through rspec.
+
+```shell
+$ rspec
+```
+
+The command line interface is tested through cucmber/aruba.
+
+```shell
+$ cucumber
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/chivy

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'commander/import'
+require 'chivy'
+
+program :name, 'chivy'
+program :version, Chivy::VERSION
+program :description, 'List and fill missing translation keys in YAML-files.'
+
+default_command :check
+
+command :list do |c|
+  c.syntax      = 'chivy [list|ls|check] [options]'
+  c.description = 'List missing keys'
+  c.example 'List missing translation keys', 'chivy list'
+  c.example 'List missing translation keys of in directory config/locales/', 'chivy list config/locales'
+  #c.example 'List missing translation keys in directory config/locales/application*', 'chivy list config/locales/application*'
+  c.action do |args, options|
+
+    folder = args[1] || '.'
+
+    files = Dir.entries(folder)
+
+    # find base locales
+    base_locales = {}
+    base_names = {}
+    files.each do |filename|
+      if filename.match(/(\S*)\.(\S*)(.yml)/)
+
+
+        tree = Chivy::Tree.new filename
+        tree.load File.join(folder, filename)
+
+        if base_locales.include? tree.locale
+          base_locales[tree.locale] << tree.name
+        else
+          base_locales[tree.locale] = [tree.name]
+        end
+
+        if base_names.include? tree.name
+          base_names[tree.name] << tree
+        else
+          base_names[tree.name] = [tree]
+        end
+      else
+        # TODO error message
+
+      end
+    end
+
+    processed_files = []
+
+    base_names.each_key do |name|
+      reference_tree = base_names[name].first
+      base_names[name].each do |tree|
+        next if tree.file == reference_tree.file
+
+        puts "--- #{reference_tree.file} to #{tree.file}"
+
+        diffs = HashDiff.diff(reference_tree.tree, tree.tree)
+        diffs.each do |diff_set|
+          if diff_set[0] == '-' || diff_set[0] == '+' || diff_set[2] == nil || diff_set[3] == nil
+            puts "#{diff_set[0]} #{diff_set[1]}: #{diff_set[2]}"
+          end
+        end
+      end
+    end
+  end
+end
+alias_command :ls, :list, :check

data/chivy.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chivy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chivy"
+  spec.version       = Chivy::VERSION
+  spec.authors       = ["Daniel Senff"]
+  spec.email         = ["mail@danielsenff.de"]
+  spec.summary       = %q{List and fill missing translation keys in YAML-files.}
+  spec.description   = %q{Offers a quick way of analyzing language YAML-files and to add missing translation keys from the CLI.}
+  spec.homepage      = "http://github.com/Dahie/chivy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "commander"
+  spec.add_dependency "hashdiff"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/chivy/configuration.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+require 'commander'
+include Commander::UI
+
+module Chivy
+  class Configuration
+    attr_reader :adapter_settings, :woro_task_dir, :app_name
+
+    # Initialize configuration.
+    def initialize(options = {})
+      @woro_task_dir = Configuration.woro_task_dir
+      @adapter_settings = options['adapters'] || {}
+      @app_name = options['app_name']
+    end
+
+    # Load configuration file or default_options. Passed options take precedence.
+    def self.load(options = {})
+      user_options = options.reject { |k, v| !['adapters', 'app_name'].include? k }
+
+      unless File.exist? config_file
+        File.open(config_file, 'w') { |file| YAML.dump(default_options, file) }
+        say "Initialized default config file in `#{config_file}`. See 'woro help init' for options."
+      end
+
+      config_file_options = YAML.load_file(config_file)
+      new(config_file_options.merge(user_options))
+    end
+
+    # Save configuration. Passed options take precendence over default_options.
+    def self.save(options = {})
+      user_options = options.reject { |k, v| !['adapters', 'app_name'].include? k }
+      force_save = options.delete :force
+
+      if !File.exist?(config_file) || force_save
+        File.open(config_file, 'w') do |file|
+          YAML.dump(default_options.merge(user_options), file)
+        end
+        say "Initialized config file in `#{config_file}`"
+      else
+        say_error "Not overwriting existing config file `#{config_file}`, use --force to override. See 'woro help init'."
+      end
+      self
+    end
+
+    def adapter(adapter_name)
+      clazz = Object.const_get("Woro::Adapters::#{adapter_name.capitalize}")
+      clazz.new adapter_settings[adapter_name.downcase]
+    end
+
+    # Helpers
+
+    def self.config_file
+      File.join('config', 'woro.yml')
+    end
+
+    def self.woro_task_dir
+      File.join('lib', 'woro_tasks')
+    end
+
+    def self.rake_task_dir
+      File.join('lib', 'tasks')
+    end
+
+    def self.default_options
+      {
+      }
+    end
+  end
+end

data/lib/chivy/key_list.rb

@@ -0,0 +1,82 @@
+require 'ostruct'
+require 'commander'
+include Commander::UI
+
+module Chivy
+  # Generates the list of all missing keys and prints out to the console.
+  class KeyList
+    attr_reader :config, :list
+
+    def initialize(translations)
+      @config = config
+      @list = []
+    end
+
+    # Determine the max count of characters for all task names.
+    # @return [integer] count of characters
+    def width
+      @width ||= list.map { |t| t.name_with_args ? t.name_with_args.length : 0 }.max || 10
+    end
+
+    # Fill task list by loading tasks from the configured adapters and locally.
+    # @return [Object] task_list
+    def fill
+      fill_list_from_adapters
+      fill_list_from_local
+      self
+    end
+
+    # Print the current task list to console.
+    def print
+      list.each do |entry|
+        entry.headline ? print_headline(entry) : print_task_description(entry)
+      end
+    end
+
+    # Extract description from gist's data content string.
+    # @param data [Hash] gist data hash
+    # [String] description string
+    def self.extract_description(task_content)
+      # regex from http://stackoverflow.com/questions/171480/regex-grabbing-values-between-quotation-marks
+      match = task_content.match(/desc (["'])((?:(?!\1)[^\\]|(?:\\\\)*\\[^\\])*)\1/)
+      match && match[2] || 'No description'
+    end
+
+    protected
+
+    def fill_list_from_local
+      list << OpenStruct.new(headline: 'local')
+      Woro::TaskHelper.woro_task_files(config.woro_task_dir) do |file_name, data|
+        list << OpenStruct.new(name_with_args: file_name.split('.rake').first,
+                       comment: Woro::TaskList.extract_description(data))
+      end
+    end
+
+    def fill_list_from_adapters
+      adapter_settings.each do |adapter_setting|
+        list << OpenStruct.new(headline: adapter_setting[0])
+        adapter = config.adapter(adapter_setting[0])
+        files = adapter.list_contents || {}
+        files.map do |file_name, data|
+          if file_name.include? '.rake'
+            list << OpenStruct.new(name_with_args: file_name.split('.rake').first,
+                           comment: adapter.extract_description(data[:data]))
+          end
+        end
+        list.compact!
+      end
+    end
+
+    def adapter_settings
+      config.adapter_settings
+    end
+
+    def print_headline(headline)
+      say "#{headline.headline} ---"
+    end
+
+    def print_task_description(task)
+      say "  %-#{width}s   # %s" % [task.name_with_args, task.comment]
+    end
+  end
+end

data/lib/chivy/task_helper.rb

@@ -0,0 +1,100 @@
+require 'commander'
+
+module Chivy
+  # Set of helper methods used in the chivy executable
+  class TaskHelper
+    include Commander::UI
+    class << self
+      # Check if woro environment is available in project
+      def check_environment
+        return if woro_environment_setup?
+        abort 'Woro environment is not set up. Call `woro init` to do so.'
+      end
+
+      # Create the given directory, unless it already exists.
+      # @param directory [String] directory to create
+      def create_directory_unless_existing(directory)
+        return if File.exist? directory
+        FileUtils.mkdir_p directory
+        say "Created `#{directory}`"
+      end
+
+      # Write a file at a given path with the given content, unless
+      # it already exists.
+      # @param file_path [String] save the new file here
+      # @param content [String] write this into the file
+      def create_file_unless_existing(file_path, content)
+        return if File.exist? file_path
+        File.open(file_path, 'w') do |f|
+          f.puts content
+        end
+        say "Created `#{file_path}`"
+      end
+
+      # Creates all files required for a setup woro environment.
+      def create_required_files
+        create_directory_unless_existing Woro::Configuration.woro_task_dir
+        create_file_unless_existing File.join(Woro::Configuration.woro_task_dir, '.gitignore'), '*.rake'
+        create_directory_unless_existing Woro::Configuration.rake_task_dir
+        create_directory_unless_existing File.dirname(Woro::Configuration.config_file)
+
+        return if File.exist? File.join(Woro::Configuration.rake_task_dir, 'woro.rake')
+
+        woro_task_file = File.join(File.dirname(__FILE__),
+                                   'templates', 'woro.rake')
+        FileUtils.cp(woro_task_file, Woro::Configuration.rake_task_dir)
+        say "Created `woro.rake` in `#{Woro::Configuration.rake_task_dir}`"
+      end
+
+      # Returns true, if all requirements of a woro setup are met.
+      # @return [boolean] all configurations, all directories exist
+      def woro_environment_setup?
+        File.exist?(Woro::Configuration.woro_task_dir) &&
+          File.exist?(File.join('config', 'woro.yml')) &&
+          File.exist?(Woro::Configuration.rake_task_dir) &&
+          File.exist?(File.join(Woro::Configuration.rake_task_dir, 'woro.rake'))
+      end
+
+      # Display choice of adapter and return name of the chosen one.
+      # @param choices [Array] list of choices
+      # @return [String] Name of chosen adapter
+      def select_choice(choices, message)
+        choose do |menu|
+          menu.prompt = message
+          menu.choices(*choices) do |choice|
+            return choice.to_s.strip
+          end
+        end
+      end
+
+      # Choose adapter and return its settings.
+      # @param task_name [String] sanitized name of the task, used
+      # @return [Hash] Hash with adapter name and its settings
+      def choose_and_build_adapter_config(available_adapters)
+        adapter_name = select_choice available_adapters, 'Please choose a service to use with Woro:'
+        adapter = Object.const_get "Woro::Adapters::#{adapter_name}"
+        { adapter_name.downcase => adapter.setup }
+      end
+
+      # Perform an action over all files within the woro task directory
+      # @param directory [String] directory
+      # @return [Array] List of rake tasks in the directory
+      def woro_task_files(directory)
+        tasks = []
+        Dir.foreach(directory) do |file_name|
+          if file_name.include? '.rake'
+            data = File.read(File.join(directory, file_name))
+            tasks << yield(file_name, data)
+          end
+        end
+        tasks
+      end
+
+      # Read the rake task template
+      # @return [String] Content of template file
+      def read_template_file
+        File.read File.join(File.dirname(__FILE__), 'templates', 'task.rake.erb')
+      end
+    end
+  end
+end

data/lib/chivy/tree.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+
+module Chivy
+  class Tree
+
+    # Forwarding methods to the @tree
+    extend Forwardable
+
+    def_delegator :@tree, :[]
+    def_delegator :@tree, :[]=
+    def_delegator :@tree, :to_yaml
+    def_delegator :@tree, :as_yaml
+    def_delegator :@tree, :==
+    def_delegator :@tree, :eql
+
+    attr_accessor :file, :locale, :name, :tree
+
+    def load(file)
+      @file = file
+      @tree = ::YAML.load_file(file)[locale] if file
+      @tree
+    end
+
+
+    # returns self (instance of Answers) after building the tree by
+    # its template
+    def initialize(filename)
+      build_tree
+      split_filename = filename.split('.')
+      @locale = split_filename[-2]
+      @name = split_filename.first
+    end
+
+
+    # returns the tree as an instance of Hash
+    def build_tree
+      @tree = {}
+    end
+
+    # returns a yaml string of the answers
+    def self.dump(answers)
+      data.to_yaml
+    end
+
+
+    # returns an answer-intance from the yaml string
+    def self.load(string)
+      data = Tree.new
+      data.load(string)
+    end
+
+  end
+end

data/lib/chivy/tree_diff.rb

@@ -0,0 +1,17 @@
+require 'hashdiff'
+
+module Chivy
+  class TreeDiff
+
+    attr_accessor :tree_a, :tree_b
+
+    def initialize(tree_a, tree_b)
+      self.tree_a = tree_a
+      self.tree_b = tree_b
+    end
+
+    def diff
+
+    end
+  end
+end

data/lib/chivy/version.rb

@@ -0,0 +1,4 @@
+module Chivy
+  # Look shiny!
+  VERSION = "0.0.1"
+end

data/lib/chivy.rb

@@ -0,0 +1,4 @@
+require 'chivy/version'
+require 'chivy/tree'
+require 'chivy/tree_diff'
+require 'chivy/key_list'

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: chivy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Senff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  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: hashdiff
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: pry
+  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: pry-remote
+  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: pry-nav
+  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: pry-byebug
+  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: Offers a quick way of analyzing language YAML-files and to add missing
+  translation keys from the CLI.
+email:
+- mail@danielsenff.de
+executables:
+- chivy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/chivy
+- chivy.gemspec
+- lib/chivy.rb
+- lib/chivy/configuration.rb
+- lib/chivy/key_list.rb
+- lib/chivy/task_helper.rb
+- lib/chivy/tree.rb
+- lib/chivy/tree_diff.rb
+- lib/chivy/version.rb
+homepage: http://github.com/Dahie/chivy
+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.4.6
+signing_key: 
+specification_version: 4
+summary: List and fill missing translation keys in YAML-files.
+test_files: []