bogy 1.1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae5f8172026336360da584339aa6828cca89d03a
-  data.tar.gz: 189ee0b2e3b8d012c6dec8ddc03b89194e795357
+  metadata.gz: 017b3b815d63846fd691bb52d4d00e1cd5a9fbfc
+  data.tar.gz: 5c179c98447f8da644bf1b18bee7335045b9e262
 SHA512:
-  metadata.gz: b433efe21ce508cca6ef71205c287e3cace5b54b6ff67768a1f6bac5263abeca62e96086112c01a4ef31e29705f8347d749170c058536f505b88d16980bbd29a
-  data.tar.gz: 292baa92592073b05829fb3578b8ab2600db2ef0a164f8bac5acdcbae6e93459282389a16869e4687174c0d9a5e71ff780247d80492c5b8feb7eabaa356c05e6
+  metadata.gz: 2821f00a1ca2b99d8d9e68aef66fafd60b7761b827560cd81d0038c2c5bd5466b91a3c54cb12065e45c5ef8ac6e85b421b8333168369e836c7e47ad1a2fad546
+  data.tar.gz: 9dec09f747276eec7aa02e47b75f7f9256893b5c68cb3caa7fdcad774b74f153bffc9810bdbf42953f16eb4a654c5c8d294458b359190cc31a10838d60ae7f19

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # nehm change log
 
+## 1.1.1
+* Handle more errors
+* Some optimizations
+
 ## 1.1.0.1
 * Add required Ruby version (>=1.9.3)
 
@@ -9,4 +13,4 @@
 * Add test coverage (RSpec)
 
 ## 1.0
-* First version
+* First release

data/README.md

@@ -1,4 +1,4 @@
-*bogy* is Ruby wrapper for YAML, which provides a little more convenient interaction with YAML
+*bogy* is tiny Ruby tool, which provides a little more convenient interaction with YAML
 
 [![Gem Version](https://badge.fury.io/rb/bogy.svg)](http://badge.fury.io/rb/bogy)
 [![Build Status](https://travis-ci.org/bogem/bogy.svg?branch=master)](https://travis-ci.org/bogem/bogy)
@@ -7,7 +7,11 @@
 
 ## Installation
 
-    $ gem install bogy
+`gem install bogy`
+
+**or**
+
+add `gem 'bogy'` to your application's Gemfile
 
 ## Available methods
 ```ruby
@@ -15,20 +19,20 @@
 path = 'file.yml'
 yaml = Bogy.new(file: path)
 
+# Parsing hashes
+hash = { 'a' => 1, 'b' => 2 }
+yaml = Bogy.new(hash: hash)
+
 # Parsing strings
-string = "---\n:a: 1\n:b: 2\n" # Looks {a: 1, b: 2} as hash
+string = "---\na: 1\nb: 2\n" # Looks {'a' => 1, 'b' => 2} as hash
 yaml = Bogy.new(string: string)
 
 yaml['foo'] = 'bar' # => "bar". Automatically writes to file, if you parse file
 yaml['foo'] # => "bar"
 yaml.delete('foo') # => "bar". Also automatically writes to file, if you parse file
-yaml.to_h # => {:a=>1, :b=>2}
-yaml.to_yaml # => ---\n:a: 1\n:b: 2\n"
-yaml.write_to_file('another_yaml_file.yml') # Writes to 'another_yaml_file.yml' file
-
-# Also you can easy convert hash to YAML and write it to file
-hash = {a: 1, b:2}
-Bogy.new(hash: hash).write_to_file('file.yml') # Automatically converts to YAML
+yaml.to_h # => {'a'=>1, 'b'=>2}
+yaml.to_yaml # => ---\na: 1\nb: 2\n"
+yaml.write_to_file('yaml_file.yml') # Converts to YAML and writes to 'yaml_file.yml' file
 ```
 
 ## License

data/bogy.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['albertnigma@gmail.com']
 
   spec.summary       = %q{Ruby wrapper for YAML}
-  spec.description   = %q{bogy is Ruby wrapper for YAML, which provides a little more convenient interaction with YAML}
+  spec.description   = %q{bogy is tiny Ruby tool, which provides a little more convenient interaction with YAML}
   spec.homepage      = 'https://github.com/bogem/bogy'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 1.9.3'

data/lib/bogy.rb

@@ -7,19 +7,17 @@ require 'bogy/hash_handler'
 require 'bogy/string_handler'
 
 class Bogy
-  def initialize(options = nil)
-    # If user provides no arguments
-    fail ArgumentError, 'wrong number of arguments (0 for 1)' if options.nil?
-
-    # If user provides more than one arguments
-    fail ArgumentError, 'you should provide only one argument' if options.length > 1
+  def initialize(options = {})
+    # If user provides incorrect number of arguments (not one)
+    fail ArgumentError, "wrong number of arguments (#{options.length} for 1)" if options.length > 1 || options.empty?
 
     @handler =
-      if options[:file]
+      case
+      when options[:file]
         FileHandler.new(options[:file])
-      elsif options[:hash]
+      when options[:hash]
         HashHandler.new(options[:hash])
-      elsif options[:string]
+      when options[:string]
         StringHandler.new(options[:string])
       end
   end

data/lib/bogy/handler.rb

@@ -1,14 +1,14 @@
 class Bogy
   # Abstract class for handlers (FileHandler, StringHandler...)
+  # Handler is object, which can work with certain data type (string, YAML file and etc.)
+  # and convert it to Ruby hash
   class Handler
     def hash
-      load_to_hash
+      @hash ||= load
     end
 
+    # Abstract method
+    # Used to convert raw YAML data from specified format to Ruby hash
     def load; end
-
-    def load_to_hash
-      @hash ||= load
-    end
   end
 end

data/lib/bogy/version.rb

@@ -1,3 +1,3 @@
 class Bogy
-  VERSION = '1.1.0.1'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/bogy/writeable.rb

@@ -1,4 +1,6 @@
 class Bogy
+  # Abstract module
+  # Used to specify what handler can write
   module Writeable
     def write; end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogy
 version: !ruby/object:Gem::Version
-  version: 1.1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Albert Nigmatzianov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-description: bogy is Ruby wrapper for YAML, which provides a little more convenient
-  interaction with YAML
+description: bogy is tiny Ruby tool, which provides a little more convenient interaction
+  with YAML
 email:
 - albertnigma@gmail.com
 executables: []
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for YAML