thinreports-template-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afffc8182c660702d271faf5ab029bd370679441
-  data.tar.gz: a60ffa8861f7757be372e58968eb7d95842e1ed5
+  metadata.gz: c01446ac5f5aca364c004e034ed55fd81dcf15c5
+  data.tar.gz: 4776236fe60edc99f03dd792270c69d29bc7004b
 SHA512:
-  metadata.gz: ef8d79172c2451e6191ceda3ef4d488398c7360349d93d1550b93bf6a2535dff2fdaae816fed0f06275967d1738f8d0c67684d3bfe1b38130394497ce7dcce95
-  data.tar.gz: a00ffc2ea727f54676c8fd294a3005cf3c0cae57e06dd9aa009cf8ae9d5bf022f0558f5689dcc8abb52b9d2b84e705dccfdba5b34cb414e15867997412f9a7f7
+  metadata.gz: b07b21e31de9a97fa89f190faeb3cbe49330f3168d145b847b26864e4b1c49eeea2a20028341cd77e8f3fa62b54027f5769faf33edb649facd6dfc43d5e88b20
+  data.tar.gz: 70448ce9bf1fa3152fe4b7c9ac6992e353103a4a422d87540392359ca5c28725e5790378eecd9144196fa0032eb9680e19a5b56083e18ed8d05a11d38f66667c

data/README.md

@@ -1,64 +1,63 @@
-# thinreports-template-cli
+[![Version](https://img.shields.io/gem/v/thinreports-template-cli.svg)](https://rubygems.org/gems/thinreports-template-cli)
 
-## Installation
+# Thinreports Templete CLI
 
-Add this line to your application's Gemfile:
+## Installation
 
-```ruby
-gem 'thinreports-template-cli'
+```sh
+$ gem install thinreports-template-cli
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Thinreports Templete CLI is able to receive parameters of text blocks in a TLF (thinreports layout format) file as options of the command line program.
 
-Or install it yourself as:
+The command supports the following formats:
 
-    $ gem install thinreports-template-cli
+* table
+* csv
+* json
+* pdf
 
-## Usage
+```sh
+$ thinreports-template-cli sample.tlf --help
+thinreports-template-cli tlf [options]
 
-```bash
-$ thinreports-template-cli help
-Commands:
-  thinreports-template-cli config --layout=LAYOUT    # Create config file for .tlf
-  thinreports-template-cli generate --layout=LAYOUT  # Generate a PDF file from .tlf to stdout
-  thinreports-template-cli help [COMMAND]            # Describe available commands or one specific command
-  thinreports-template-cli info --layout=LAYOUT      # Display information for .tlf
-```
+Basic Options
+        --format=table|csv|json|pdf
 
-```bash
-$ thinreports-template-cli info --layout=~/template.tlf
+Thinreports Layout File Options
+        --date=[DATE]                This is a sample date.
+        --subject=[SUBJECT]          This is a sample subject.
+        --name=[NAME]                This is a sample name.
+        --number=[NUMBER]            This is a sample number.
+        --date_jp=[DATE_JP]          This is a sample date for Japanese era name.
 ```
 
-```bash
-$ thinreports-template-cli config --layout=~/template.tlf > config.yml
-$ cat ~/config.yml
----
-name: Taro Tottori
-item: Toripy Plush Toy
-price: 2980
-```
+### Datetime Support
 
-```bash
-$ thinreports-template-cli generate --layout=~/template.tlf --config=~/config.yml > example.pdf
-```
+* A option value for a text block of a datetime format is parsed by [DateTime#parse](https://ruby-doc.org/stdlib/libdoc/date/rdoc/DateTime.html#method-c-parse).
+* A text block of a datetime format is rendered by the strftime format of [DateTime#strftime](https://ruby-doc.org/stdlib/libdoc/date/rdoc/DateTime.html#method-i-strftime) and [era_ja](https://rubygems.org/gems/era_ja).
+* If a text block of a datetime format does not have a command line option or a default value of a TLF file, this text block will be rendered with [Datetime#now](https://ruby-doc.org/stdlib/libdoc/date/rdoc/DateTime.html#method-c-now).
 
-```bash
-$ thinreports-template-cli generate --layout=~/template.tlf --config=~/config.yml | lpr -P ApeosPort_V_C3375__aa_bb_cc_
-```
-
-## Development
+## Examples
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Output to a PDF file.
 
-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
+```bash
+$ thinreports-template-cli sample.tlf --name="Your name" --date=2017-04-01" --format=pdf > sample.pdf
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/thinreports-template-cli.
+Output to a printer via the lpr command.
 
+```bash
+$ thinreports-template-cli sample.tlf --name="Your name" --date=2017-04-01" --format=pdf | lpr -P ApeosPort_V_C3375__aa_bb_cc_
+```
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Author
+
+Masayuki Higashino

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/exe/thinreports-template-cli

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'thinreports/template/cli'
-
-Thinreports::Template::CLI::Commands.start(ARGV)
+require 'thinreports/template-cli/cli'
+Thinreports::TemplateCLI::CLI.start(ARGV)

data/lib/thinreports/template-cli/cli.rb

@@ -0,0 +1,44 @@
+require 'optparse'
+require 'thinreports'
+require 'thinreports/template-cli/version'
+require 'thinreports/template-cli/thinreports'
+require 'thinreports/template-cli/views'
+
+module Thinreports
+  module TemplateCLI
+    class CLI
+
+      def self.start(argv)
+
+        layout = nil
+        format = nil
+        params = {}
+
+        options = OptionParser.new
+        options.version = Thinreports::TemplateCLI::VERSION
+        options.banner = "#{options.program_name} tlf [options]"
+        options.separator('')
+        options.separator('Basic Options')
+        options.on('--format=table|csv|json|pdf') { |value|
+          format = value
+        }
+
+        layout = argv.find{ |arg| FileTest.file?(arg) }
+        if layout
+          report = Thinreports::Report.new(layout:layout)
+          options.separator('')
+          options.separator('Thinreports Layout File Options')
+          report.textblocks.each do |shape|
+            options.on("--#{shape.id}=[#{shape.id.upcase}]", shape.attributes['description']) { |value|
+              params[shape.id] = value
+            }
+          end
+        end
+
+        options.parse!(argv)
+        puts Views.new(layout, format, params).render
+      end
+
+    end
+  end
+end

data/lib/thinreports/template-cli/datetime.rb

@@ -0,0 +1,31 @@
+require 'date'
+require 'era_ja'
+
+module Thinreports
+  module TemplateCLI
+    class DateTime
+
+      private_class_method :new
+      def initialize(datetime)
+        @datetime = datetime
+      end
+
+      def self.now
+        new(::DateTime.now)
+      end
+
+      def self.parse(*args)
+        new(::DateTime.parse(*args))
+      end
+
+      def strftime(format)
+        @datetime.to_era(format)
+      end
+
+      def to_s
+        @datetime.to_s
+      end
+
+    end
+  end
+end

data/lib/thinreports/template-cli/thinreports.rb

@@ -0,0 +1,29 @@
+require 'thinreports'
+
+class Thinreports::Report::Base
+
+  def textblocks
+    default_layout.format.shapes.values.select{ |s|
+      s.type == Thinreports::Core::Shape::TextBlock::TYPE_NAME
+    }
+  end
+
+end
+
+class Thinreports::Core::Shape::TextBlock::Format
+
+  def format_value
+    value = ''
+    if format_datetime_format
+      value << format_datetime_format
+    end
+    if format_number_delimiter
+      value << "delimiter=[#{format_number_delimiter}]"
+    end
+    if format_number_precision
+      value << "/precision=[#{format_number_precision}]"
+    end
+    return value
+  end
+
+end

data/lib/thinreports/template-cli/version.rb

@@ -0,0 +1,5 @@
+module Thinreports
+  module TemplateCLI
+    VERSION = '0.3.0'.freeze
+  end
+end

data/lib/thinreports/template-cli/views.rb

@@ -0,0 +1,103 @@
+require 'tty-table'
+require 'csv'
+require 'json'
+require 'thinreports'
+require 'thinreports/template-cli/datetime'
+
+module Thinreports
+  module TemplateCLI
+    class Views
+
+      def initialize(layout, format, params)
+        @layout = layout
+        @format = format
+        @params = params
+      end
+
+      def render
+        case @format
+        when 'table'; to_table
+        when 'csv'  ; to_csv
+        when 'json' ; to_json
+        when 'pdf'  ; to_pdf
+        else to_table
+        end
+      end
+
+      private
+
+      def to_table
+        table = TTY::Table.new(header:header, rows:rows)
+        TTY::Table::Renderer::ASCII.new(table).render
+      end
+
+      def to_csv
+        CSV.generate do |csv|
+          csv << header
+          rows.each do |row|
+            csv << row.values
+          end
+        end
+      end
+
+      def to_json
+        rows.to_json
+      end
+
+      def to_pdf
+        report.generate
+      end
+
+      def header
+        @header ||= %w(id ref_id display multiple default_value option_value real_value fmt_base fmt_type fmt_value desc)
+      end
+
+      def rows
+        unless @rows
+          @rows = []
+          report.textblocks&.each do |shape|
+            @rows << {
+              'id' => shape.id,
+              'ref_id' => shape.ref_id,
+              'display' => shape.display?,
+              'multiple' => shape.multiple?,
+              'default_value' => shape.value,
+              'option_value' => @params[shape.id].to_s,
+              'real_value' => report.page.manager.shapes[shape.id.to_sym]&.internal&.real_value,
+              'fmt_base' => shape.format_base,
+              'fmt_type' => shape.format_type,
+              'fmt_value' => shape.format_value,
+              'desc' => shape.attributes['description']
+            }
+          end
+        end
+        return @rows
+      end
+
+      def report
+        unless @report
+          @report = Thinreports::Report.new(layout:@layout)
+          @report.start_new_page
+          @report.default_layout.format.shapes.values.each do |shape|
+            case shape.type
+            when Thinreports::Core::Shape::TextBlock::TYPE_NAME
+              if shape.has_format?
+                case shape.format_type
+                when 'datetime'
+                  if @params[shape.id]
+                   @params[shape.id] = DateTime.parse(@params[shape.id])
+                  else
+                   @params[shape.id] = shape.value.empty? ? DateTime.now : DateTime.parse(shape.value)
+                  end
+                end
+              end
+            end
+          end
+          @report.page.values(@params)
+        end
+      return @report
+      end
+
+    end
+  end
+end

data/lib/thinreports/template-cli.rb

@@ -0,0 +1,2 @@
+require 'thinreports/template-cli/version'
+require 'thinreports/template-cli/cli'

data/thinreports-template-cli.gemspec

@@ -1,31 +1,28 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'thinreports/template/cli/version'
+require 'thinreports/template-cli/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'thinreports-template-cli'
-  spec.version       = Thinreports::Template::CLI::VERSION
-  spec.authors       = ['mh61503891']
+  spec.version       = Thinreports::TemplateCLI::VERSION
+  spec.authors       = ['Masayuki Higashino']
   spec.email         = ['msyk@hgsn.info']
-
-  spec.summary       = %q{A command line tool to generate a PDF file from YAML config file and .tlf}
-  spec.description   = %q{A command line tool to generate a PDF file from YAML config file and .tlf}
+  spec.summary       = %q{A command line tool to generate a PDF file from TLF with command line options and YAML config file.}
+  spec.description   = spec.summary
   spec.homepage      = 'https://github.com/mh61503891/thinreports-template-cli'
   spec.license       = 'MIT'
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
-  spec.add_dependency 'thinreports', '0.9.1'
-  spec.add_dependency 'thor', '0.19.1'
-  spec.add_dependency 'wareki', '0.1.2'
-  spec.add_dependency 'kosi', '1.0.0'
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.add_dependency 'thinreports', '0.10.0'
+  spec.add_dependency 'era_ja', '0.5.2'
+  spec.add_dependency 'tty-table', '0.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'awesome_print', '~> 1.7.0'
-  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0'
+  spec.add_development_dependency 'awesome_print', '~> 1.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinreports-template-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- mh61503891
+- Masayuki Higashino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thinreports
@@ -16,128 +16,128 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: era_ja
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
-  name: wareki
+  name: tty-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: kosi
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: '1.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
-description: A command line tool to generate a PDF file from YAML config file and
-  .tlf
+        version: '0.10'
+description: A command line tool to generate a PDF file from TLF with command line
+  options and YAML config file.
 email:
 - msyk@hgsn.info
 executables:
@@ -154,10 +154,12 @@ files:
 - bin/console
 - bin/setup
 - exe/thinreports-template-cli
-- lib/thinreports/template/cli.rb
-- lib/thinreports/template/cli/commands.rb
-- lib/thinreports/template/cli/executor.rb
-- lib/thinreports/template/cli/version.rb
+- lib/thinreports/template-cli.rb
+- lib/thinreports/template-cli/cli.rb
+- lib/thinreports/template-cli/datetime.rb
+- lib/thinreports/template-cli/thinreports.rb
+- lib/thinreports/template-cli/version.rb
+- lib/thinreports/template-cli/views.rb
 - thinreports-template-cli.gemspec
 homepage: https://github.com/mh61503891/thinreports-template-cli
 licenses:
@@ -171,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -179,8 +181,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: A command line tool to generate a PDF file from YAML config file and .tlf
+summary: A command line tool to generate a PDF file from TLF with command line options
+  and YAML config file.
 test_files: []

data/lib/thinreports/template/cli/commands.rb

@@ -1,37 +0,0 @@
-require 'thor'
-require 'thinreports/template/cli/executor'
-
-module Thinreports; module Template; module CLI; class Commands < Thor
-
-  desc 'generate', 'Generate a PDF file from .tlf to stdout'
-  option :layout, required:true
-  option :config
-  def generate
-    print Thinreports::Template::CLI::Executor.new(get_report, get_config).generate
-  end
-
-  desc 'info', 'Display information for .tlf'
-  option :layout, required:true
-  option :config
-  def info
-    print Thinreports::Template::CLI::Executor.new(get_report, get_config).info
-  end
-
-  desc 'config', 'Create config file for .tlf'
-  option :layout, required:true
-  def config
-    print Thinreports::Template::CLI::Executor.new(get_report).config
-  end
-
-  no_commands {
-
-    def get_report
-      return Thinreports::Report.new(layout:File.expand_path(options.layout))
-    end
-
-    def get_config
-      options.config && YAML.load_file(File.expand_path(options.config)) || {}
-    end
-
-  }
-end; end; end; end

data/lib/thinreports/template/cli/executor.rb

@@ -1,52 +0,0 @@
-require 'thinreports'
-require 'yaml'
-require 'wareki'
-require 'kosi'
-
-module Thinreports; module Template; module CLI; class Executor
-
-  def initialize(report, config=nil)
-    @report = report
-    @config = config
-  end
-
-  def generate
-    @report.start_new_page
-    @report.default_layout.format.shapes.values.each do |shape|
-      case shape.type
-      when Thinreports::Core::Shape::TextBlock::TYPE_NAME
-        if shape.has_format? && shape.format_type == 'datetime'
-          @config[shape.id] ||= Date.today
-        end
-      else
-      end
-    end
-    @report.page.values(@config)
-    @report.generate
-  end
-
-  def info
-    kosi = Kosi::Table.new({
-      align: Kosi::Align::TYPE::LEFT,
-      header: %w(b:id b:type b:display? bf:value tb:has_format? tb:format_type)
-    })
-    return kosi.render(@report.default_layout.format.shapes.values.map { |s|
-      record = [s.id, s.type, s.display?, s.value]
-      case s.type
-      when Thinreports::Core::Shape::TextBlock::TYPE_NAME
-        record += [s.has_format?, s.format_type]
-      else
-        record += [nil, nil]
-      end
-    })
-  end
-
-  def config
-    @config = {}
-    @report.default_layout.format.shapes.values.map do |shape|
-      @config[shape.id] = shape.value
-    end
-    YAML.dump(@config)
-  end
-
-end; end; end; end

data/lib/thinreports/template/cli/version.rb

@@ -1,3 +0,0 @@
-module Thinreports; module Template; module CLI
-  VERSION = '0.2.0'
-end; end; end

data/lib/thinreports/template/cli.rb

@@ -1,3 +0,0 @@
-require 'thinreports/template/cli/version'
-require 'thinreports/template/cli/commands'
-require 'thinreports/template/cli/executor'