textractor-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b793d5e572fe214d8bca7f529d968a8eac1150cb
+  data.tar.gz: 7957d1348be2c6366b7ea93d247c1bdfe01f4023
+SHA512:
+  metadata.gz: cef651fd17b0b3d4b4fde2df393ed573fa334a3787f35a30dc251b50b2fea58c483a3b74422a12cdff408612525adb4b7a8b4c2e3334dd73d298e017161ed4fc
+  data.tar.gz: 0c571030e8f296c6406b7322cbcf322205aa11b0b38609aa6581b8d7d67cb0591d755baaaf56a49d229f452600ffc7a8a3d9d457a8604a3148c2f0aa401f4dcf

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.swp
+*.rbc
+*.html
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    textractor-cli (0.1.0)
+      methadone (~> 1.9.5)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.2)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    builder (3.2.3)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.1)
+    contracts (0.16.0)
+    cucumber (2.4.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 4.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.18)
+    gherkin (4.1.3)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    methadone (1.9.5)
+      bundler
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
+    netrc (0.11.0)
+    power_assert (1.0.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.5.0)
+    rdoc (5.1.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    slop (3.6.0)
+    test-unit (3.2.5)
+      power_assert
+    thor (0.19.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.14)
+  pry
+  pry-remote
+  rake (~> 10.0)
+  rdoc
+  test-unit
+  textractor-cli!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 snootysoftware
+
+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,71 @@
+## Textractor CLI
+
+Command-line client for the Textractor service that automatically prepares ERB templates for internationalization. See https://textractor.snootysoftware.com for more information.
+
+### Step 1. Install our open source client
+
+It's as simple as running:
+
+`gem install textractor-cli`
+
+### Step 2. Configure your license key
+
+Create a file `.textractor.rc` in your home directory, with the following content:
+
+```
+  ---
+  license-key: foo
+    
+```
+
+Replace "foo" with your license key.
+
+### Step 3. Extract string literals!
+
+To extract literals, run the following in your Rails project root:
+
+`textractor`
+
+This will convert your files to their translation-ready versions and add the original strings to your locale/en.yml file. To be safe, make sure to commit them to version control first.
+
+By default, textractor will create Rails-compatible `t('.foo')` calls and add the string literals using the Rails standard structure. You can override these settings using command-line arguments. Scroll down for more information.
+
+### Example
+
+
+```
+      $ cd myrailsproject
+      $ cat app/views/foo/index.html.erb
+      Hello World
+
+      $ cat config/locales/en.yml
+      ---
+      en:
+
+      $ textractor
+      Processing...
+
+      Processed 1 templates in total.
+      Total errors: 0
+      Total amount of string literals prepared for translation: 1
+
+      $ cat app/views/foo/index.html.erb
+      t('.hello_world')
+
+      $ cat config/locales/en.yml
+      ---
+      en:
+        foo:
+          index:
+            hello_world: Hello World
+```
+
+### More options
+
+`textractor --dry-run` can be used to find out how many credits your project requires.
+
+`textractor --template-pattern` can be used to set the Dir.glob which determines which ERB files will be processed. Our default pattern is made for Rails projects: `app/views/**/*.html.erb`
+
+`textractor --locale-path` determines which locale file will be updated with the original strings. The default is the English language for Rails: `config/locales/en.yml`
+
+`textractor --absolute-keys` forces the keys in `t()` calls to be absolute: `t('foo.index.hello_world')` instead of `t('.hello_world')`

data/README.rdoc

@@ -0,0 +1,19 @@
+= textractor-cli - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2017 YOUR NAME
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,61 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "textractor/cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/textractor

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'textractor/cli.rb'
+require 'rest-client'
+require 'json'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do
+    locale_file = options['locale-path']
+    exit_now!(1, "Error: could not find a locale file at: #{locale_file}") unless File.exist?(locale_file)
+
+    url = ENV['API_BASE_URL'] || "https://textractor.snootysoftware.com"
+    url += options['dry-run'] ? "/quote" : '/textract'
+    payload = {}
+    glob = File.join(options['templates-path'], options['templates-pattern'])
+
+    key = options['license-key'] || ENV['TEXTRACTOR_API_KEY']
+    unless key
+      exit_now!(1,"No license key found. Use --licence-key flag, ~/.textractor.rc or TEXTRACTOR_API_KEY environment variable. Visit https://textractor.snootysoftware.com to order one.")
+    end
+
+    headers = {
+      'X-Auth-Token' => key
+    }
+
+    result = {}
+    result["textract_calls"] = 0 if options['dry-run']
+    Dir[glob].each do |f|
+      puts "Processing #{f}..."
+      payload = {}
+      payload["name"] = f
+      payload["template"] = File.read(f)
+      payload[:absolute_keys] = true if options['absolute-keys']
+      response = RestClient.post(url, payload.to_json, headers)
+      response = JSON.parse(response)
+      if options['dry-run']
+        result["current_credits"] = response['current_credits']
+        result["textract_calls"] += response['textract_calls']
+      else
+        response.each do |k,v|
+          result[k] = v
+        end
+      end
+    end
+
+    if options['dry-run']
+      puts "Amount of templates to be processed: #{Dir[glob].size}"
+      puts "Amount of t() calls: #{result["textract_calls"]}"
+      puts "Current credits: #{result["current_credits"]}"
+      credits_after_textract = result["current_credits"] - result["textract_calls"]
+      puts "Credits after textract: #{credits_after_textract}"
+    else
+      locale = YAML.load_file(locale_file)
+      locale['en'] ||= {}
+
+      total_calls = 0
+      total_errors = 0
+      result.each do |k,v|
+        raise "unexpected path \"#{k}\" in result!" unless Dir[glob].include?(k)
+        File.write(k, v["result"]) unless v["error"]
+        key = k.sub(options['templates-path'],'')
+               .sub(/^\//,'')
+               .sub(/(\.html)?\.erb/,'').split('/')
+
+        tmp = locale['en']
+        key.each do |part|
+          tmp[part] ||= {}
+          tmp = tmp[part]
+        end
+        (v["locale"] || {}).each {|kk,vv| tmp[kk] = vv }
+        if v["error"]
+          puts "\n Error processing \"#{k}\": #{v["error"]}"
+          total_errors += 1
+        else
+          total_calls += v["textract_calls"]
+        end
+      end
+      File.write(locale_file, YAML.dump(locale))
+      puts "\n"
+      puts "Processed #{Dir[glob].size} templates in total."
+      puts "Total errors: #{total_errors}"
+      puts "Total amount of string literals prepared for translation: #{total_calls}"
+    end
+  end
+
+  options['templates-pattern'] = "**/*.html.erb"
+  on("--templates-pattern PATTERN", "Dir.glob() pattern used to match templates filenames")
+
+  options['templates-path'] = "app/views"
+  on("--templates-path PATH", "Template path")
+
+  options['locale-path'] = "config/locales/en.yml"
+  on("--locale-path PATH", "Path of target YAML locale file")
+
+  on("--absolute-keys", "Generate `t('posts.index.title')` rather than `t('.title')`)")
+
+  on("--dry-run", "Get statistics and cost estimate from server without processing")
+
+  on("--license-key KEY", "Get your key at https://textractor.snootysoftware.com")
+
+  defaults_from_config_file '.textractor.rc'
+
+  version Textractor::Cli::VERSION
+
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
+
+  go!
+end

data/lib/textractor/cli.rb

@@ -0,0 +1,7 @@
+require "textractor/cli/version"
+
+module Textractor
+  module Cli
+    # Your code goes here...
+  end
+end

data/lib/textractor/cli/version.rb

@@ -0,0 +1,5 @@
+module Textractor
+  module Cli
+    VERSION = "0.1.0"
+  end
+end

data/textractor-cli.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textractor/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textractor-cli"
+  spec.license       = ""
+  spec.version       = Textractor::Cli::VERSION
+  spec.authors       = ["Lucas & Joachim"]
+  spec.email         = ["info@snootysoftware.com"]
+
+  spec.summary       = %q{Command line tool for the Textractor service.}
+  spec.homepage      = "https://github.com/snootysoftware/textractor-cli"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["textractor"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('pry')
+  spec.add_development_dependency('pry-remote')
+  spec.add_dependency('rest-client')
+  spec.add_dependency('methadone', '~> 1.9.5')
+  spec.add_development_dependency('test-unit')
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: textractor-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas & Joachim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rdoc
+  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: aruba
+  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: rest-client
+  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: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: 
+email:
+- info@snootysoftware.com
+executables:
+- textractor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- bin/console
+- bin/setup
+- bin/textractor
+- lib/textractor/cli.rb
+- lib/textractor/cli/version.rb
+- textractor-cli.gemspec
+homepage: https://github.com/snootysoftware/textractor-cli
+licenses:
+- ''
+metadata:
+  allowed_push_host: https://rubygems.org
+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.13
+signing_key: 
+specification_version: 4
+summary: Command line tool for the Textractor service.
+test_files: []