puttext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 823ff8ebbbb9be8b240a4f4fe20472a1ef871c5b
+  data.tar.gz: c8ea456d1fb5f0de5c98591f05d3c2b14ce3f8f4
+SHA512:
+  metadata.gz: 33d5d1d97efe0ebb8e0e69192a358462739dad3879c5b58fbf7d087cff10f253d81587ddf0efa1d559bbf6b395446f32d7bd3be07dd695c191815847c79b700a
+  data.tar.gz: 73e68f79ad334014c5309e38550fc1d990bad7d757f888dda4285e693553692c72675c243406c5c0a7779792ae089d8a427bd0a0bffbe88042b3635d37851abe

data/.codeclimate.yml

@@ -0,0 +1,19 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text eol=lf
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc  diff=astextplain
+*.DOC  diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF  diff=astextplain
+*.rtf  diff=astextplain
+*.RTF  diff=astextplain

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.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/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,26 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'spec/fixtures/**/*'
+  TargetRubyVersion: 2.0
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/EndOfLine:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+addons:
+  code_climate:
+    repo_token: 2df66540ac895ba609ec19665a233e73dc7b4d3f3e0c788c4b99ed974765d4bf
+
+after_success:
+  - bundle exec codeclimate-test-reporter
+
+notifications:
+  email: false
+
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puttext.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    puttext (0.0.1)
+      parser (>= 2.4.0.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.0.4)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.1)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slim (3.0.7)
+      temple (~> 0.7.6)
+      tilt (>= 1.3.3, < 2.1)
+    temple (0.7.7)
+    tilt (2.0.7)
+    unicode-display_width (1.2.1)
+    unindent (1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 1.0.0)
+  puttext!
+  rake
+  rspec (~> 3.5)
+  rubocop (~> 0.46.0)
+  simplecov
+  slim (~> 3.0)
+  unindent
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mantas Norvaiša
+
+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,82 @@
+[![Build Status](https://travis-ci.org/mntnorv/puttext.svg)](https://travis-ci.org/mntnorv/puttext)
+[![Code Climate](https://codeclimate.com/github/mntnorv/puttext/badges/gpa.svg)](https://codeclimate.com/github/mntnorv/puttext)
+[![Test Coverage](https://codeclimate.com/github/mntnorv/puttext/badges/coverage.svg)](https://codeclimate.com/github/mntnorv/puttext/coverage)
+
+# puttext
+
+Put translatable gettext strings from your Ruby code to a `.po` or `.pot` file.
+
+For example, if you have this `translatable.rb` file:
+```ruby
+puts _('translatable string')
+```
+
+You get this output:
+```po
+#: translatable.rb:1
+msgid "translatable string"
+msgtxt ""
+```
+
+## Language support
+
+Supports extracting strings from these types of files:
+- Ruby
+- Slim
+
+## Installation
+
+Using RubyGems:
+```bash
+$ gem install puttext
+```
+
+Or add it to your `Gemfile` if using Bundler:
+```ruby
+gem 'puttext', require: false
+```
+
+Also, if you want additional language support beyond plain Ruby, install these gems:
+- [**slim**](https://github.com/slim-template/slim) for Slim support.
+
+
+## Usage
+
+Just run the `puttext` command line tool and point it to your Ruby project:
+```bash
+$ puttext /path/to/your/project
+```
+
+### Options
+
+#### `-o`, `--output`
+
+By default `puttext` will output the extracted PO file contents to stdout. You can write the output to a file by specifying the `-o`, `--output` option.
+
+```bash
+$ puttext /path/to/your/project -o template.pot
+```
+
+## Contributing
+
+Before submitting an Issue or Pull Request always check if your issue is already being discussed or if someone has already submitted a pull request with the feature you want to add. Also, before doing bigger changes, it's always good to discuss the changes you're going to make in an Issue.
+
+### Code style
+
+PutText uses RuboCop (https://github.com/bbatsov/rubocop) to check and enforce code style. Before submitting a pull request, make sure that RuboCop does not find any offenses.
+
+#### Running RuboCop
+
+```bash
+$ bundle exec rubocop
+```
+
+### Testing
+
+PutText uses RSpec (http://rspec.info/) for testing. Pull requests with Ruby code changes must include RSpec tests that check the new functionality or changed code. Also, make sure that your changes do not break any existing tests.
+
+#### Running RSpec
+
+```bash
+$ bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/bin/puttext

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/puttext/cmdline'
+
+PutText::Cmdline.run(ARGV)

data/lib/puttext.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'puttext/extractor'
+
+module PutText
+end

data/lib/puttext/cmdline.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'extractor'
+require 'optparse'
+
+module PutText
+  class Cmdline
+    USAGE_TEXT = 'Usage: puttext LOCATION [options]'.freeze
+
+    # Run the commmand line tool puttext.
+    # @param [Array<String>] args the command line arguments.
+    def self.run(args)
+      new.run(args)
+    end
+
+    # Run the commmand line tool puttext.
+    # @param [Array<String>] args the command line arguments.
+    def run(args)
+      options = parse_args(args)
+      po_file = Extractor.new.extract(options[:path])
+
+      if options[:output_file]
+        with_output_file(options[:output_file]) { |f| po_file.write_to(f) }
+      else
+        po_file.write_to(STDOUT)
+      end
+    rescue => e
+      error(e)
+    end
+
+    private
+
+    def with_output_file(path)
+      File.open(path, 'w') do |f|
+        yield(f)
+      end
+    end
+
+    def error(exception)
+      puts "error: #{exception.message}"
+      puts exception.backtrace
+      exit 1
+    end
+
+    def parse_args(args)
+      args_left, options = parse_options(args)
+
+      if args_left.length != 1
+        puts USAGE_TEXT
+        exit 1
+      else
+        options[:path] = args_left[0]
+        options
+      end
+    end
+
+    def parse_options(args)
+      options = {}
+
+      args_left = OptionParser.new do |opts|
+        opts.banner = USAGE_TEXT
+
+        opts.on('-o', '--output PATH', 'Output file path') do |o|
+          options[:output_file] = o
+        end
+      end.parse!(args)
+
+      [args_left, options]
+    end
+  end
+end

data/lib/puttext/extractor.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative 'parser/ruby'
+require_relative 'parser/slim'
+require_relative 'po_file'
+
+module PutText
+  class Extractor
+    EXTENSIONS = {
+      '.rb'   => 'Ruby',
+      '.slim' => 'Slim'
+    }.freeze
+
+    # Thrown when a given file cannot be parsed, because its format or language
+    # is not supported.
+    class UnsupportedFileError < StandardError; end
+
+    # Thrown when the path passed to #extract does not exist.
+    class NoSuchFileError < StandardError; end
+
+    # Return the class of a parser by its name
+    # @param [String] name the name of the parser.
+    # @return [Class] the classof the parser
+    def self.parser_class_by_name(name)
+      PutText::Parser.const_get(name)
+    end
+
+    # Check if a file is supported by the parser, based on its extension.
+    # @return [Boolean] whether the file is supported.
+    def self.file_supported?(path)
+      EXTENSIONS.each do |ext, parser_name|
+        next unless path.end_with?(ext)
+        next unless parser_class_by_name(parser_name)
+        return true
+      end
+
+      false
+    end
+
+    # Extract strings from files in the given path.
+    # @param [String] path the path of a directory or file to extract strings
+    #   from.
+    # @return [POFile] a POFile object, representing the strings extracted from
+    #   the files or file in the specified path.
+    def extract(path)
+      files           = files_in_path(path)
+      supported_files = filter_files(files)
+
+      parse_files(supported_files)
+    end
+
+    # Parse gettext strings from a file in the path.
+    # @param [String] path the path of the file to parse.
+    # @return [Array<POEntry>] an array of POEntry objects extracted
+    #   from the given file.
+    def extract_from_file(path)
+      parser_by_path(path).strings_from_file(path)
+    end
+
+    private
+
+    def parser_by_name(name)
+      return @parsers[name] if @parsers && @parsers[name]
+
+      @parsers ||= {}
+      parser_class = self.class.parser_class_by_name(name)
+      return unless parser_class
+
+      parser = parser_class.new
+      @parsers[name] = parser
+      parser
+    end
+
+    def parser_by_path(path)
+      EXTENSIONS.each do |ext, name|
+        return parser_by_name(name) if path.end_with?(ext)
+      end
+
+      raise UnsupportedFileError, format('file not supported: %s', path)
+    end
+
+    def parse_files(files)
+      entries = []
+
+      files.each do |path|
+        entries += extract_from_file(path)
+      end
+
+      POFile.new(entries)
+    end
+
+    def filter_files(files)
+      supported_files = files.select do |file|
+        self.class.file_supported?(file)
+      end
+
+      supported_files
+    end
+
+    def files_in_path(path)
+      files = []
+
+      if File.file?(path)
+        files = [path]
+      elsif File.directory?(path)
+        files = Dir.glob(File.join(path, '**/*'))
+      else
+        raise NoSuchFileError, format('no such file or directory: %s', path)
+      end
+
+      files
+    end
+  end
+end