configstruct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb58d6d732dd097347d370186a628e928d952895
+  data.tar.gz: f3bcc9f1cd3a29221290012cb695f74e58e84563
+SHA512:
+  metadata.gz: 2fd2311c70f643639a514fa977474f2e0211ef0efb6a41d6940f76cd749fa1a624976d87a31907853f0b2432a34672dc385b1bb35103454ef7005f2475ec1100
+  data.tar.gz: fa588bd523532d54302959fe8d9a23e225dd2c597a38dfc7176fe1a825d695695fed476895a071e9b553c0edfbd4e29cb997d5af6ab95e8373a822dbcedbddb5

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: PJCj4fDDbnGb3BA3qehKdZmQOWGXVulAl

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+mkmf.log
+vendor/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --path vendor
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+ConfigStruct Changelog
+=======================
+
+v0.0.1 - 2014-05-31
+-----------------------
+
+- basic test coverage
+- base structure
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mose
+
+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,62 @@
+Configstruct
+=============
+
+[![Gem Version](https://badge.fury.io/rb/configstruct.png)](http://rubygems.org/gems/configstruct)
+[![Build Status](https://travis-ci.org/mose/configstruct.png?branch=master)](https://travis-ci.org/mose/configstruct)
+[![Coverage Status](https://coveralls.io/repos/mose/configstruct/badge.png)](https://coveralls.io/r/mose/configstruct)
+[![Dependency Status](https://gemnasium.com/mose/configstruct.svg)](https://gemnasium.com/mose/configstruct)
+[![Code Climate](https://codeclimate.com/github/mose/configstruct.png)](https://codeclimate.com/github/mose/configstruct)
+
+----
+
+This gem is a lib for managing configfile for cli applications, including
+
+- call a setup of the config file if it does not exist
+- edit configuration and update the config file
+
+It's for now totally experimental, please do not use yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configstruct'
+
+## Usage
+
+````ruby
+require 'cliprompt'
+class Config < ConfigStruct
+
+  include Cliprompt
+
+  def set_defaults
+    super
+    default :name, 'default'
+    default :url, 'http://greenruby.org'
+  end
+
+  def setup
+    values = {}
+    output.puts Paint['Applicaton configuration.', :blue]
+    values['api_id'] = guess 'API_CLIENT', 'What is your Client ID?'
+    values['api_secret'] = guess 'API_SECRET', 'What is your Secret Key?'
+    write values
+  end
+
+end
+````
+
+## Contributing
+
+1. Fork it
+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
+
+Copyright
+----------
+
+(c) Copy is right, 2014 - mose - this code is distributed under MIT license
+

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task' # RSpec 2.0
+
+desc 'launch rspec tests'
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
+    t.pattern = 'spec/lib/**/*_spec.rb'
+  end
+end
+
+task default: :spec

data/configstruct.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "configstruct"
+  spec.version       = File.read(File.expand_path('../CHANGELOG.md', __FILE__))[/([0-9]+\.[0-9]+\.[0-9]+)/]
+  spec.authors       = ["mose"]
+  spec.email         = ["mose@mose.com"]
+  spec.summary       = %q{Lib for managing config files based on OpenStruct.}
+  spec.description   = %q{Lib for managing config files based on OpenStruct, includes file saving and prompt at creation.}
+  spec.homepage      = "https://github.com/mose/configstruct"
+  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(/^spec\//)
+  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 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/config_struct.rb

@@ -0,0 +1,44 @@
+require 'ostruct'
+require 'yaml'
+
+class ConfigStruct < OpenStruct
+
+  def initialize(options = nil, input = STDIN, output = STDOUT)
+    super(options)
+    set_defaults
+    prepare_dirs
+    addvalues
+  end
+
+  def set_defaults
+    default :basedir, '/tmp'
+    default :basefile, File.join(self.basedir, 'config.yml')
+  end
+
+  def prepare_dirs
+    FileUtils.mkdir_p self.basedir unless Dir.exist? self.basedir
+  end
+
+  def addvalues
+    setup unless File.exist? self.basefile
+    YAML.load_file(self.basefile).each do |k, v|
+      new_ostruct_member(k)
+      send("#{k}=", v)
+    end
+  end
+
+  def setup
+    write Hash.new
+  end
+
+  def default(var, value)
+    send(var).nil? && send("#{var}=", value)
+  end
+
+  def write(values)
+    File.open(self.basefile, 'w') do |f|
+      f.write YAML.dump(values)
+    end
+  end
+
+end

data/spec/files/config.yml

@@ -0,0 +1,5 @@
+---
+somevar: somevalue
+somearray:
+  - value 1
+  - value 2

data/spec/lib/config_struct_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'config_struct'
+
+describe ConfigStruct do
+
+  let(:basedir) { File.expand_path('../../files', __FILE__) }
+  let(:basefile) { File.expand_path('../../files/config.yml', __FILE__) }
+  let(:options) { { basedir: basedir, basefile: basefile } }
+  let(:value1) { 'newdefault' }
+
+  describe '.default' do
+    subject { ConfigStruct.new options }
+    before { subject.default :var, value1 }
+    it { expect(subject.var).to eq value1 }
+  end
+
+  describe 'new' do
+    context 'when there is no config file, ' do
+      let(:basefile) { File.expand_path('../../files/xxx.yml', __FILE__) }
+      after { FileUtils.rm basefile if File.exist? basefile }
+      subject { ConfigStruct.new options }
+      it 'then a config file is created calling' do
+        expect(subject.basefile).to eq basefile
+        expect(File.exist? basefile).to be_true
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'rubygems'
+require 'bundler'
+
+if ENV['COV']
+  require 'simplecov'
+  SimpleCov.profiles.define :app do
+    add_filter '/vendor/'
+    add_filter '/spec/'
+  end
+  SimpleCov.start :app
+else
+  require 'coveralls'
+  Coveralls.wear!
+
+  # require "codeclimate-test-reporter"
+  # CodeClimate::TestReporter.start
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+# Warning:
+# I'm not an expert tester, and on this project I wanted to try
+# a super-isolation way. So each spec is testing each method and
+# uses a lock of stubbing and doubles. Up to now I find it quite
+# convenient because it makes the interdependencies more obvious,
+# and when something changes in the code the need for changes in
+# the stubbing is an occasion to think about the whole architecture.
+# Also, it doesn't lie about the coverage, by stubbing all things,
+# a thing is not covered if not explicitely tested.

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: configstruct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 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: coveralls
+  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: codeclimate-test-reporter
+  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: Lib for managing config files based on OpenStruct, includes file saving
+  and prompt at creation.
+email:
+- mose@mose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- configstruct.gemspec
+- lib/config_struct.rb
+- spec/files/config.yml
+- spec/lib/config_struct_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mose/configstruct
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lib for managing config files based on OpenStruct.
+test_files:
+- spec/files/config.yml
+- spec/lib/config_struct_spec.rb
+- spec/spec_helper.rb