fillparams 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b88aeb7930519bfc66751d9f379ec588ce39b20d
+  data.tar.gz: 65d9c29154e466e7165d1ba30092cc4e4a518bb5
+SHA512:
+  metadata.gz: 69be4a484fedad6c41448ca14119e1e21ae2ab55750e42aab0bb2e7d29158b3cabbe864c2360cd56d2f9c7d817be82fbce37749d32665c306502e715c15ad4fa
+  data.tar.gz: cb1b92e75f6fe49ce4d1490ef108174d4db3eed9e9bfb0f29233ea6d53d4b06a2da5b0e8395b21f1fb03440c518a490c4d37e8f46ab1c775fd46c5bfc3ea787a

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+.idea
+mkmf.log
+test.yml

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--profile
+--order rand

data/FillParams.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'FillParams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fillparams'
+  spec.version       = FillParams::VERSION
+  spec.authors       = ['Krzysztof Hasiński', 'Justyna Wojtczak']
+  spec.email         = ['krzysztof.hasinski+parameterhandler@gmail.com']
+  spec.summary       = 'Parameters handler'
+  spec.description   = 'A gem for filling in parameters automatically'
+  spec.homepage      = ''
+  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_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-activemodel-mocks'
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Krzysztof Hasiński
+
+MIT License
+
+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,72 @@
+# FillParams
+
+This tool allows you to manage ignored YAML parameters in your config files. 
+It is inspired by [Incenteev ParameterHandler](https://github.com/Incenteev/ParameterHandler).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fillparams'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fillparams
+
+## Usage
+
+By default, the dist file is assumed to be in the same place than the parameters
+file, suffixed by ``.dist``.
+
+The script handler will ask you interactively for parameters which are missing
+in the parameters file, using the value of the dist file as default value.
+All prompted values are parsed as inline YAML, to allow you to define ``true``,
+``false``, ``null`` or numbers easily.
+
+If fillparams is run in a non-interactive mode, the values of the dist file
+will be used for missing parameters.
+
+**Warning:** This parameters handler will overwrite any comments or spaces into
+your parameters.yml file so handle with care. If you want to give format
+and comments to your parameter's file you should do it on your dist version.
+
+Basic usage is:
+
+    $ fillparams
+    
+This will look for a file called `init.yml`, which should contain:
+
+    files:
+        - some_config.yml
+        - config/database.yml
+        - more_configs.yml
+        
+fillparams will look for each of those files and a corresponding ``.dist`` file (ex. ``config/database.yml.dist``),
+go through parameters and ask for the missing ones. Check ``fillparams --help`` for more options. 
+
+**Important:** fillparams will ask for parameters that are strings, numbers, arrays, nulls (nils) and booleans. For
+hashes it will go deeper until it finds something to work on.
+
+For example in file ``database.yml.dist``
+
+    development:
+        username: dbuser
+        host: localhost
+        fancy_options: 
+            - a
+            - b
+            - c
+
+it will ask for `username`, `host` and `fancy_options`, it **won't** ask for `development` itself as it can go deeper into nested options.
+
+## Contributing
+
+1. Fork it ( https://github.com/khasinski/fillparams/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/fillparams

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+# For running without installation:
+# ruby -Ilib bin/fillparams
+
+require 'optparse'
+require 'ostruct'
+require 'config_manager'
+require 'parameter_filler'
+
+options = OpenStruct.new
+options.init_file = 'init.yml'
+options.verbose = false
+options.interactive = STDIN.isatty
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: fillparams [-i init.yml] [-v] [-n]'
+
+  opts.on('-i', '--init [INIT_FILE]',
+    'provide init file', '(list of configuration files to fill in)') do |init|
+    options.init_file = init
+  end
+
+  opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+    options.verbose = v
+  end
+
+  opts.on('-n', '--non-interactive', 'Run without asking for parameters') do |n|
+    options.interactive = !n
+  end
+end.parse!
+
+conf = ConfigManager.new(options.init_file)
+parameter_filler = ParameterFiller.new(conf.get_config_files, options.verbose, options.interactive)
+parameter_filler.fill_file_list

data/init.yml

@@ -0,0 +1,2 @@
+files:
+  - test.yml

data/lib/FillParams/version.rb

@@ -0,0 +1,3 @@
+module FillParams
+  VERSION = '0.0.1'
+end

data/lib/FillParams.rb

@@ -0,0 +1,5 @@
+require 'FillParams/version'
+
+module FillParams
+
+end

data/lib/config_manager.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'yaml'
+
+class ConfigManager
+  attr_reader :init_file
+
+  def initialize(init_yml_file)
+    @init_file = load init_yml_file
+  end
+
+  def load yml_file
+    YAML.load_file(yml_file)
+  end
+
+  def get_config_files
+    @init_file && @init_file.has_key?('files') ? @init_file['files'] : []
+  end
+end
+

data/lib/parameter_filler.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+
+class ParameterFiller
+
+  attr_reader :config_files
+  attr_reader :verbose
+  attr_reader :interactive
+
+  def initialize(files_list, verbose, interactive)
+    @config_files = files_list
+    @verbose = verbose
+    @interactive = interactive
+  end
+
+  def fill_file_list
+    @config_files.each do |file_name|
+      if verbose
+        puts 'Filling ' + file_name + '...'
+      end
+      fill_file file_name
+    end
+  end
+
+  def fill_file(file_name)
+    dist_file_name = file_name + '.dist'
+    setup_files(file_name, dist_file_name)
+    config_data = load_yaml_file file_name
+    dist_data = load_yaml_file dist_file_name
+    config_data = fill_parameters(config_data, dist_data)
+    File.write(file_name, config_data.to_yaml)
+  end
+
+  def load_yaml_file(file_name)
+    begin
+      data = YAML.load_file(file_name)
+      unless data
+        data = {}
+      end
+    rescue Exception => e
+      raise ArgumentError, 'Invalid YAML in config file ' + file_name unless data
+    end
+    data
+  end
+
+  def setup_files(file_name, dist_file_name)
+    raise ArgumentError, 'Dist file not found for ' + file_name unless File.file?(dist_file_name)
+    unless File.file?(file_name)
+      File.write(file_name, '')
+    end
+    return
+  end
+
+  def fill_parameters(data, dist_data)
+    dist_data.each do |key, value|
+      if !data.has_key?(key) && !dist_data[key].is_a?(Hash)
+        data[key] = ask_for_param(key, value)
+      end
+      if dist_data[key].is_a?(Hash)
+        unless data.has_key?(key)
+          data[key] = {}
+        end
+        data[key] = fill_parameters(data[key], dist_data[key])
+      end
+    end
+    data
+  end
+
+  def ask_for_param(key, default)
+    return default unless interactive
+    print "Key \"#{key}\" (default: #{default}): "
+    param = gets.chomp
+    if param.empty? || !interactive
+      param = default
+    else
+      param = YAML.load(param)
+    end
+    param
+  end
+end
+

data/spec/foobar_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+describe ParameterFiller do
+  pending "write it"
+  it 'should be true' do
+    expect(1).to eq 1
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'rspec/active_model/mocks'
+
+require 'parameter_filler.rb'
+
+Bundler.setup
+
+RSpec.configure do |config|
+end

data/test.yml.dist

@@ -0,0 +1,9 @@
+number: 1
+float: 3.2
+string: 'text'
+array:
+  - "array_elem_1"
+  - "array_elem_2"
+  - array_elem_3: {'nested_obj_1':'text'}
+object:
+  hash: "hash_value"

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: fillparams
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Krzysztof Hasiński
+- Justyna Wojtczak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rspec-activemodel-mocks
+  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: A gem for filling in parameters automatically
+email:
+- krzysztof.hasinski+parameterhandler@gmail.com
+executables:
+- fillparams
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- FillParams.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fillparams
+- init.yml
+- lib/FillParams.rb
+- lib/FillParams/version.rb
+- lib/config_manager.rb
+- lib/parameter_filler.rb
+- spec/foobar_spec.rb
+- spec/spec_helper.rb
+- test.yml.dist
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Parameters handler
+test_files:
+- spec/foobar_spec.rb
+- spec/spec_helper.rb