configstruct 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d65d2c8e268ef10541747c3aefaf9cc24d750e54
-  data.tar.gz: 37d8459de43f1f92e99b19ff502b07f837e6e9e2
+  metadata.gz: f9e6ed7a4fc44632fc1a402fdaecc3933e5c7799
+  data.tar.gz: c364d1390c0058a08b860501136885af8711eb59
 SHA512:
-  metadata.gz: fcfb7686bdaba07dee5bc8179d808e22279bbdd2b6fdf131ec6b366257deed5a1a35a4fb97a4600d4208c73e0fe8c6c518838990cdfb73833afbb2195de542b3
-  data.tar.gz: c5a5a5eb499e8fd56ff4295664708573c7620c7da1c01659ddd9d5adbc1baf4a68bc4c31f6f88f99733a83d89ca904139d93d84710482d8b960dc921c72996b2
+  metadata.gz: 2ee4ad4f1b48e5dcf3a045b1fba3dbbfdacc2a15995bb7f6a78ea64c8f145f64dc409b3965955c986d4d7520ba6e30c2a2347ec2fa815c4caa261c41e10fc411
+  data.tar.gz: 5005bc1b18655b808ac35699580f26a2fc0355f9e0af4027b0e84c0810cfca704b42e96875083cd0210d3f13bb3f118dbc6e103aa06120c963be5d7120a74ac4

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 ConfigStruct Changelog
 =======================
 
+v0.1.0 - 2015-11-16
+----------------------
+- fix tests for rspec3
+- add some code documentation
+
 v0.0.4 - 2014-08-19
 -----------------------
-- add a furth params at init for conductig the behaviour of overriding values from options provided
+- add a fourth params at init for conducting the behaviour 
+  of overriding values from options provided
 
 v0.0.3 - 2014-06-01
 -----------------------

data/README.md

@@ -7,6 +7,7 @@ Configstruct
 [![Coverage Status](https://img.shields.io/coveralls/mose/configstruct.svg)](https://coveralls.io/r/mose/configstruct?branch=master)
 [![Dependency Status](https://img.shields.io/gemnasium/mose/configstruct.svg)](https://gemnasium.com/mose/configstruct)
 [![Code Climate](https://img.shields.io/codeclimate/github/mose/configstruct.svg)](https://codeclimate.com/github/mose/configstruct)
+[![Inch](https://inch-ci.org/github/mose/configstruct.svg)](https://inch-ci.org/github/mose/configstruct)
 
 ----
 

data/lib/configstruct.rb

@@ -1,8 +1,14 @@
 require 'ostruct'
 require 'yaml'
 
+# the Configstruct object
+# inherits from OpenStruct and adds some features:
+# - set default values
+# - redirects output and input IO to custom streams
+# - writes file on disk as yaml
 class ConfigStruct < OpenStruct
 
+  # creates new object
   def initialize(options = nil, input = STDIN, output = STDOUT, unless_set = false)
     super(options)
     @input = input
@@ -13,15 +19,18 @@ class ConfigStruct < OpenStruct
     addvalues
   end
 
+  # sets defaults value for initializer
   def set_defaults
     default :basedir, '/tmp'
     default :basefile, File.join(self.basedir, 'config.yml')
   end
 
+  # creates dir where to store config if it does not exist
   def prepare_dirs
     FileUtils.mkdir_p self.basedir unless Dir.exist? self.basedir
   end
 
+  # adds value in the configuration hash
   def addvalues
     setup unless File.exist? self.basefile
     YAML.load_file(self.basefile).each do |k, v|
@@ -32,32 +41,39 @@ class ConfigStruct < OpenStruct
     end
   end
 
+  # creates a blank config file with empty values
   def setup
     write Hash.new
   end
 
+  # attributes value if it is nil
   def default(var, value)
     send(var).nil? && send("#{var}=", value)
   end
 
+  # writes config faile on disk as yaml
   def write(values)
     File.open(self.basefile, 'w') do |f|
       f.write YAML.dump(values)
     end
   end
 
+  # redirect puts to the initialized output
   def puts(*string)
     @output.puts *string
   end
 
+  # redirect print to the initialized output
   def print(*string)
     @output.print *string
   end
 
+  # redirect printf to the initialized output
   def printf(string, *args)
     @output.printf string, *args
   end
 
+  # redirect gets fromm the initialized input
   def gets(*args)
     @input.gets *args
   end

data/spec/lib/configstruct_spec.rb

@@ -23,7 +23,7 @@ describe ConfigStruct do
       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
+        expect(File.exist? basefile).to be_truthy
       end
     end
   end
@@ -47,7 +47,7 @@ describe ConfigStruct do
         expect(output.string).to eq "-- #{str} --"
       end
       it 'redirect gets to StringIO object' do
-        input.stub(:gets).and_return(str)
+        allow(input).to receive(:gets).and_return(str)
         expect(subject.gets).to eq str
       end
     end

data/spec/spec_helper.rb

@@ -12,9 +12,6 @@ if ENV['COV']
 else
   require 'coveralls'
   Coveralls.wear!
-
-  # require "codeclimate-test-reporter"
-  # CodeClimate::TestReporter.start
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configstruct
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !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:
@@ -88,15 +74,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- configstruct.gemspec
 - lib/configstruct.rb
 - spec/files/config.yml
 - spec/lib/configstruct_spec.rb
@@ -121,11 +101,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Lib for managing config files based on OpenStruct.
 test_files:
-- spec/files/config.yml
-- spec/lib/configstruct_spec.rb
 - spec/spec_helper.rb
+- spec/lib/configstruct_spec.rb
+- spec/files/config.yml

data/.coveralls.yml

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

data/.gitignore

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

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

data/Gemfile

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

data/Rakefile

@@ -1,20 +0,0 @@
-#!/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

@@ -1,25 +0,0 @@
-# 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