jafry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ffbe42f6432e9ce9d24ce1692f7e7ce4333aded
-  data.tar.gz: 7a63cc15a34f237302475ebbbfe6eaec3047d28f
+  metadata.gz: a9863ee8e6abf4b6d4f8aba49ea6b41122416f4a
+  data.tar.gz: 08a660e1a68d756ab3ee1e9be8490907eab61003
 SHA512:
-  metadata.gz: cb3a4ee6b52a3da13111ad045521e980b7756d2f7e9a8a98a1dffaf7144899b6405efeff3d19d7143f10b846c02692279ebb85d6bb387e45d85f9dbc0688e465
-  data.tar.gz: e2615ae2c8d78dfdf341a98643b9c22cfea51e482243e8795ad5229d13af381caa1a94e2304f7cddebb7231b906b316851cd311d8b1e7b437398991ea585b047
+  metadata.gz: 198ae3da6fe4cbd9b397c8fca45012d8ca88aa84ab57f101ea274c703dc35adf93ce57df92a608144a62765c1e672b216f410096666cd55d996eb5ced3ff0b44
+  data.tar.gz: 1f508036377378b7d4ef3a8f82e81d0271dfd4ec07e0d3522ecc69aef7827a14487c70066cae020852d2c1e114b559bf1f8babc32447e455f5edefcccf68bfa6

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 cache: bundler
 
 rvm:
-  - ruby
   - 2.1.1
 
 script: 'bundle exec rake'

data/README.md

@@ -1,6 +1,14 @@
 # Jafry
+[![Build Status](https://travis-ci.org/igorrKurr/jafry.svg?branch=master)](https://travis-ci.org/igorrKurr/jafry)
+[![Gem Version](https://badge.fury.io/rb/jafry.svg)](http://badge.fury.io/rb/jafry)
+[![Coverage Status](https://img.shields.io/coveralls/igorrKurr/jafry.svg)](https://coveralls.io/r/igorrKurr/jafry?branch=master)
+[![Code Climate](https://codeclimate.com/github/igorrKurr/jafry/badges/gpa.svg)](https://codeclimate.com/github/igorrKurr/jafry)
 
-TODO: Write a gem description
+This gem allows you to easily create JSON data fixtures from data schemes you can specify by yourself.
+The main purpose is to stub JSON received form wide range of JSON API's for testing.
+And if you use many API's or kind of difficult one you may want to have a tool for easy creation of tons of JSON data you have.
+And Jafry can help you here.
+Just specify data scheme in json file and then you can change your data easly, wrap it namespaces, build lists, etc.
 
 ## Installation
 
@@ -18,7 +26,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Create file `data_scheme_name.json`.
+2. Put json data in it.
+3. In your `spec_helper.rb` require `jafry`: `require "jafry"`.
+4. Call `Jafry.build('data_scheme_name')` to get object or `Jafry.create('data_scheme_name')` in your spec.
 
 ## Contributing
 

data/jafry.gemspec

@@ -8,8 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = Jafry::VERSION
   spec.authors       = ["Igor Kur"]
   spec.email         = ["kur91@mail.ru"]
-  spec.summary       = %q{Gem for stub json data}
-  spec.description   = %q{}
+  spec.summary       = %q{Gem for creating JSON data stubs}
+  spec.description   = %q{This gem allows you to easily create JSON data fixtures
+                          from data schemes you can specify by yourself.
+                          The main purpose is to stub JSON received form wide range of JSON API's.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -24,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "yajl-ruby"
   spec.add_development_dependency "hashie"
+  spec.add_development_dependency "yard"
 end

data/lib/jafry.rb

@@ -1,13 +1,21 @@
 require 'jafry/version'
 require 'jafry/actions'
 
+# Main Jafry module
+#
+# @attr [String] schemes_path Path to Jafry schemes
+
 module Jafry
   extend Actions
 
+  # Schemes path attr getter
+
   def self.schemes_path
     @@schemes_path
   end
 
+  # Schemes path attr setter
+
   def self.schemes_path=(schemes_path)
     @@schemes_path = schemes_path
   end

data/lib/jafry/actions.rb

@@ -1,7 +1,17 @@
 require 'yajl'
 require 'jafry/scheme'
 
+# This module contains main functionality for Jafry
+
 module Actions
+  # Return object builded from scheme
+
+  # @param scheme_name [String] Scheme name
+  # @param [Hash] options Options
+  # @option options [String] :wrap Namespace to wrap scheme in
+  # @return [Scheme] New Scheme object build with pointed options
+  # @see Scheme
+
   def build(scheme_name, options={})
     scheme = Scheme.new(scheme_name)
     options.each do |attr, value|
@@ -11,16 +21,42 @@ module Actions
     scheme
   end
 
+  # Return json from scheme
+
+  # @param scheme_name [String] Scheme name
+  # @param options [Hash] Options
+  # @option options [String] :wrap Namespace to wrap json in
+  # @return [Scheme] New Scheme object encoded to json
+  # @see Scheme
+
   def create(scheme_name, options={})
     Yajl::Encoder.encode(build(scheme_name, options))
   end
 
+  # Retun array of Scheme objects
+
+  # @param scheme_name [String] Scheme name
+  # @param count [Integer] Number of objects in array
+  # @param options [Hash] Options
+  # @option options [String] :wrap Namespace to wrap list in
+  # @return [Array] Array of Schemes
+  # @see Scheme
+
   def build_list(scheme_name, count, options={})
     list = []
     count.times {list << build(scheme_name, options)}
     list
   end
 
+  # Retun array of Scheme objects encoded to json
+
+  # @param scheme_name [String] Scheme name
+  # @param count [Integer] Number of objects in array
+  # @param options [Hash] Options
+  # @option options [String] :wrap Namespace to wrap json list in
+  # @return [Array] Json array of schemes
+  # @see Scheme
+
   def create_list(scheme_name, count, options={})
     Yajl::Encoder.encode(build_list(scheme_name, count, options))
   end

data/lib/jafry/scheme.rb

@@ -1,16 +1,48 @@
 require 'yajl'
 require 'hashie'
 
+# Class for parsing json scheme
+
 class Scheme < Hashie::Mash
+  #Initialize Scheme
+  #
+  # @raise [Exception] Raises when json scheme file not found
+
   def initialize(path)
-    super(Yajl::Parser.new.parse(File.read("#{Jafry.schemes_path}/#{path}.json")))
+    begin
+      raise "Please, create correct scheme file first" unless File.exists?(build_schemes_path(path))
+      super(Yajl::Parser.new.parse(File.read(build_schemes_path(path))))
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
+    end
   end
 
+  # Return json from scheme
+  #
+  # @return [String] JSON from scheme
+
   def build
     Yajl::Encoder.encode self
   end
 
-  def wrap(name)
-    {"#{name}" => self}
+  # Wraps current scheme in specified namespace
+  #
+  # @return [Hash] Wrapped hash
+
+  def wrap(namespace)
+    {"#{namespace}" => self}
+  end
+
+  private
+
+  # Method for creating full path to scheme file
+  #
+  # @private
+  # @param scheme [String] Scheme name
+  # @return [String] Full path to file
+
+  def build_schemes_path(scheme)
+    "#{Jafry.schemes_path}/#{scheme}.json"
   end
 end

data/lib/jafry/version.rb

@@ -1,3 +1,3 @@
 module Jafry
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/scheme_spec.rb

@@ -1,21 +1,31 @@
 require 'spec_helper'
 
 describe Scheme do
-  before(:each) do
+  before(:all) {Jafry.schemes_path = '.'}
+  context "from existing file" do
+    before(:each) do
     File.open("test.json", 'w+') {|f| f.write(%Q({"name":"test"})) }
-    Jafry.schemes_path = './'
     @scheme = Scheme.new('test')
+    end
+    after(:each) do
+      File.delete("test.json")
+    end
+    it 'initializes from file' do
+      expect(@scheme.name).to eq('test')
+    end
+    it 'builds json' do
+      expect(@scheme.build).to eq(%Q({"name":"test"}))
+    end
+    it 'wraps json' do
+      expect(@scheme.wrap("user")).to eq({"user" => {"name" => "test"}})
+    end
+    it 'builds schemes path' do
+      expect(@scheme.send(:build_schemes_path, 'foo')).to eq("./foo.json")
+    end
   end
-  after(:each) do
-    File.delete("test.json")
-  end
-  it 'initializes from file' do
-    expect(@scheme.name).to eq('test')
-  end
-  it 'builds json' do
-    expect(@scheme.build).to eq(%Q({"name":"test"}))
-  end
-  it 'wraps json' do
-    expect(@scheme.wrap("user")).to eq({"user" => {"name" => "test"}})
+  context "from unexisting file" do
+    it "returns `create file` caution" do
+      expect { Scheme.new('foo') }.to output(/Please, create correct scheme file first/).to_stdout
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jafry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: |-
+  This gem allows you to easily create JSON data fixtures
+                            from data schemes you can specify by yourself.
+                            The main purpose is to stub JSON received form wide range of JSON API's.
 email:
 - kur91@mail.ru
 executables: []
@@ -139,8 +156,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Gem for stub json data
+summary: Gem for creating JSON data stubs
 test_files:
 - spec/jafry_spec.rb
 - spec/scheme_spec.rb
 - spec/spec_helper.rb
+has_rdoc: