ecg 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f7dd877779549c7b32707909f9165d0d3e4b51490764301c58315da585cbf7
-  data.tar.gz: 48ab0baed120e7892e0398a312a9cc30532946d51e3a08b882094562e5d27601
+  metadata.gz: d22e44c0a03b9a540006d7c0502e8c3c73101f7c446c9c05393ba5319bdc57ae
+  data.tar.gz: 03e5ed33aacd6ef40dfb7d7c0da2533d572259f444ce08e57d6a077bf4a64436
 SHA512:
-  metadata.gz: d281193f36bcbdd4de0ed51196a109e8e50baf27ce183d32012c4ac85805bf9c8668f8c590bb30439cd10cf4ec3931df156db351f23cc3ce6e8d3cf05322bd73
-  data.tar.gz: aa9f2782085a6747227a04529ee6f7efacf0f338e562f5230e2b4e8a173c1dd75c35f864222127cf4876f5422bded891c08176168d93f67bd31957571e2d4b67
+  metadata.gz: a6177f797de5728e5daf1f30b2178cb4f25c6281dc1cf2c9452afa88c9d1f5de54eabd3aa5afb12a40a05512e819a551bc052a92d7bbbeb17f3b35b008c37272
+  data.tar.gz: 59e1caa2a49b47af62ce27ee6b7b008ad3c8df286d7e84a77d0224892b9dd14dc9226d3586a50f637efe13e55e6869055797ec9b78673172168bd6fbbe506c74

data/README.md

@@ -14,7 +14,10 @@ Ruby: 2.4 or higher
 gem install ecg
 ```
 
-## Simple Usage
+## Usage
+See also `ecg --help`
+
+### Simple example
 ```sh
 ecg --values name=epaew --values email="epaew.333@gmail.com" < template.json.erb
 {
@@ -47,5 +50,88 @@ with
     email: epaew.333@gmail.com
     ```
 
+### Using nested keys
+```sh
+ecg --values user.name=epaew --values user.email="epaew.333@gmail.com" < template.json.erb
+{
+  "user": {
+    "name": "epaew",
+    "email": "epaew.333@gmail.com"
+  }
+}
+```
+or
+```sh
+ecg config.yml < template.json.erb
+{
+  "user": {
+    "name": "epaew",
+    "email": "epaew.333@gmail.com"
+  }
+}
+```
+with
+* template.json.erb
+    ```json
+    {
+      "user": {
+        "name": "<%= user.name %>",
+        "email": "<%= user.email %>"
+      }
+    }
+    ```
+* config.yml
+    ```yaml
+    user:
+      name: epaew
+      email: epaew.333@gmail.com
+    ```
+
+### Using array (JSON and YAML only)
+```sh
+ecg config.yml < template.json.erb
+{
+  "user": [
+    {
+      "name": "Kurimu"
+    },
+    {
+      "name": "Chizuru"
+    },
+    {
+      "name": "Minatsu"
+    },
+    {
+      "name": "Mahuyu"
+    }
+  ]
+}
+```
+with
+* template.json.erb
+    ```json
+    {
+      "user": [
+    <% users.each_with_index do |user, i| %>
+        {
+          "name": "<%= user.name %>"
+    <% unless i == users.count - 1 %>
+        },
+    <% else %>
+        }
+    <% end %>
+    <% end %>
+      ]
+    }
+    ```
+* config.yml
+    ```yaml
+    users:
+      - name: Kurimu
+      - name: Chizuru
+      - name: Minatsu
+      - name: Mahuyu
+    ```
+
 ## License
 [MIT](LICENSE)

data/lib/ecg/command.rb

@@ -2,17 +2,19 @@
 
 require 'erb'
 require_relative 'option_parser'
-require_relative 'store'
 
 module ECG
   class Command
     def initialize(args)
-      parser = OptionParser.new(args)
-      @store = parser.parse!
+      @parser = OptionParser.new(args)
     end
 
     def execute(input = $stdin, output = $stdout)
-      output.puts ERB.new(input.read).result(@store.binding)
+      context = @parser.context
+      # NOTE: ERB.new's non-keyword arguments are deprecated in 2.6
+      # erb = ERB.new(input.read, trim_mode: context.trim_mode)
+      erb = ERB.new(input.read, nil, context.trim_mode)
+      output.puts erb.result(context.values.binding)
     end
   end
 end

data/lib/ecg/context.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'store'
+
+module ECG
+  class Context
+    attr_reader :trim_mode
+
+    def initialize(filepath:, trim_mode:, values:)
+      @trim_mode = trim_mode
+      @values_file = filepath
+      @values_option = values
+    end
+
+    def values
+      Store.new(merged_hash)
+    end
+
+    private
+
+    def load_file(path)
+      case File.extname(path)
+      when '.json'
+        require 'json'
+        File.open(path) { |f| JSON.parse(f.read) }
+      when /\A\.ya?ml\z/
+        require 'yaml'
+        # NOTE: YAML.safe_load's non-keyword arguments are deprecated in 2.6
+        # File.open(path) { |f| YAML.safe_load(f.read, aliases: true) }
+        File.open(path) { |f| YAML.safe_load(f.read, [], [], true) }
+      else
+        raise ArgumentError,
+              "Cannot load file `#{path}`. Only JSON/YAML are allowed."
+      end
+    end
+
+    def merged_hash
+      hash = @values_file.nil? ? {} : load_file(@values_file)
+      hash.merge(@values_option)
+    end
+  end
+end

data/lib/ecg/option_parser.rb

@@ -1,26 +1,21 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require_relative 'store'
+require_relative 'context'
+require_relative 'version'
 
 module ECG
-  class LoadError < ::StandardError; end
-
   class OptionParser
-    attr_reader :args, :option
-
     def initialize(args = [])
       @args = args
-      @option = {}
+      @options = { filepath: nil, trim_mode: '<>', values: {} }
     end
 
-    def parse!
-      print_help(false) if @args.empty?
+    def context
+      return @context if instance_variable_defined?(:@context)
 
-      parser.parse!(@args)
-      print_help(false) if @args.length > 1
-
-      Store.new(hash)
+      parse!
+      @context = Context.new(@options)
     end
 
     private
@@ -31,39 +26,46 @@ module ECG
       __BANNER__
     end
 
-    def hash
-      hash = @args.empty? ? {} : load_file(@args.first)
-
-      hash.merge(@option)
-    end
+    def filepath
+      print_help(false) if @args.length > 1
+      return nil if @args.empty?
 
-    def load_file(path)
-      case File.extname(path)
-      when '.json'
-        require 'json'
-        File.open(path) { |f| JSON.parse(f.read) }
-      when /\A\.ya?ml\z/
-        require 'yaml'
-        File.open(path) { |f| YAML.safe_load(f.read, [], [], true) }
-      else
+      path = @args.first
+      extname = File.extname(path)
+      if %w[.json .yml .yaml].none? { |ext| ext == extname }
         raise ArgumentError,
               "Cannot load file `#{path}`. Only JSON/YAML are allowed."
       end
+
+      path
+    end
+
+    def parse!
+      print_help(false) if @args.empty?
+
+      parser.parse!(@args)
+      @options[:filepath] = filepath
+      self
     end
 
-    def parser
+    def parser # rubocop:disable Style/MethodLength
       ::OptionParser.new do |opt|
         opt.banner = banner
+        opt.version = VERSION
 
         opt.on('-v', '--values Key=Value', <<~__DESC__) do |str|
           Set the key-value mapping to be embedded in the template.
         __DESC__
 
-          key, value = str.split('=', 2)
-          @option[key] = value
+          set_option_value(*str.split('=', 2))
+        end
+        opt.on('-t', '--trim-mode MODE', <<~__DESC__) do |v|
+          Set ERB's trim_mode. Default is "<>".
+        __DESC__
+          @options[:trim_mode] = v
         end
         opt.on('-V', '--version', 'Print version information') do
-          puts "#{File.basename($PROGRAM_NAME)} #{ECG::VERSION}"
+          puts opt.ver
           exit
         end
         opt.on('-h', '--help', 'Print this help message', &method(:print_help))
@@ -74,5 +76,40 @@ module ECG
       warn parser.help
       exit bool
     end
+
+    def set_option_value(key, value)
+      keys = key.split('.').map(&:to_sym)
+      if keys.count == 1
+        set_single_option_value(keys.first, value)
+      else
+        set_nested_option_value(keys, value)
+      end
+    end
+
+    def set_single_option_value(key, value)
+      values = @options[:values]
+      if values[key].is_a? Hash
+        raise ArgumentError, 'Reaf keys cannot have own value.'
+      end
+
+      values[key] = value
+      values
+    end
+
+    def set_nested_option_value(keys, value)
+      values = @options[:values]
+      last_key = keys.pop
+
+      nested = keys.inject(values) do |result, key|
+        result[key] ||= {}
+        unless result[key].is_a? Hash
+          raise ArgumentError, 'Reaf keys cannot have own value.'
+        end
+
+        result[key]
+      end
+      nested[last_key] = value
+      values
+    end
   end
 end

data/lib/ecg/store.rb

@@ -40,18 +40,7 @@ module ECG
     end
 
     def to_h
-      @store.transform_values do |value|
-        case value
-        when self.class
-          value.to_h
-        when Array
-          value.map do |element|
-            element.respond_to?(:to_h) ? element.to_h : element
-          end
-        else
-          value
-        end
-      end
+      @store.transform_values(&method(:intransform_value))
     end
 
     def to_json(*args)
@@ -59,8 +48,25 @@ module ECG
       to_h.to_json(args)
     end
 
+    def ==(other)
+      return false unless other.is_a?(self.class)
+
+      to_h == other.to_h
+    end
+
     private
 
+    def intransform_value(value)
+      case value
+      when self.class
+        value.to_h
+      when Array
+        value.map(&method(:intransform_value))
+      else
+        value
+      end
+    end
+
     def transform_value(value)
       case value
       when Hash

data/lib/ecg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ECG
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecg
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - epaew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,7 @@ files:
 - bin/ecg
 - lib/ecg.rb
 - lib/ecg/command.rb
+- lib/ecg/context.rb
 - lib/ecg/option_parser.rb
 - lib/ecg/store.rb
 - lib/ecg/version.rb
@@ -159,7 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: ecg is an ERB(eRuby) based, simple and powerful configration file generator