accessible_seed_yaml 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1c5f8ab0391ca5c7a2ed2d56a5f1dbaa05bbbc2
+  data.tar.gz: 2593fd1b4465c338028b5ab9db9765a4bee4f387
+SHA512:
+  metadata.gz: bbc8e7f9e273be8784ba1c8d0828b66dc37817b4871b745b977a0884a2b7d0bc4ec054b5a2fc3dc9dc0fb8bb8357726edbf65526fac2122986848cb5900c5d87
+  data.tar.gz: 9d3490313fbb241a6c3ed97fe978b567cb5843924fad932245dc8b3b2415f14fca90cbf87d6ca13cb5fbb1e1b545605b42c2743f45fdabd6554a7c1b97bcee4f

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm: 2.1.2
+script: rake test

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shinya131
+
+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,75 @@
+[![Build Status](https://travis-ci.org/Shinya131/accessible_seed_yaml.svg?branch=master)](https://travis-ci.org/Shinya131/accessible_seed_yaml)
+[![Coverage Status](https://coveralls.io/repos/Shinya131/accessible_seed_yaml/badge.png?branch=develop)](https://coveralls.io/r/Shinya131/accessible_seed_yaml?branch=develop)
+[![Code Climate](https://codeclimate.com/github/Shinya131/accessible_seed_yaml/badges/gpa.svg)](https://codeclimate.com/github/Shinya131/accessible_seed_yaml)
+
+## Introduction
+`AccessibleSeedYaml` is wrapper of rails seed file.  
+This wrapper provides following function:
+
+1. Easy access interface for seed data.
+2. Hold original seed data.
+
+## Example 
+### Sample data
+numbers.yaml
+```yaml
+data1:
+  id: 1
+  name: "one"
+data2:
+  id: 2
+  name: "two"
+data3:
+  id: 3
+  name: "three"
+```
+
+### Example of `AccessibleSeedYaml::Table`
+```ruby
+require 'accessible_seed_yaml'
+
+original_seed = File.read('numbers.yaml')
+
+@table = AccessibleSeedYaml::Table.new(original_seed)
+
+# Instance is providing data access interface.
+@table.records
+# => 
+# [
+#   #<AccessibleSeedYaml::Record:0x007f91552770c0
+#    @original_seed="data1:\n  id: 1\n  name: \"one\"\n",
+#    @seed_data_by_hash={"data1"=>{"id"=>1, "name"=>"one"}}>,
+#   #<AccessibleSeedYaml::Record:0x007f915526c238
+#    @original_seed="data2:\n  id: 2\n  name: \"two\"\n",
+#    @seed_data_by_hash={"data2"=>{"id"=>2, "name"=>"two"}}>,
+#   #<AccessibleSeedYaml::Record:0x007f91552662c0
+#    @original_seed="data3:\n  id: 3\n  name: \"three\"",
+#    @seed_data_by_hash={"data3"=>{"id"=>3, "name"=>"three"}}>
+# ]
+
+@table.records[0]
+# => #<AccessibleSeedYaml::Record:0x007f9155725068
+# @original_seed="data1:\n  id: 1\n  name: \"one\"\n",
+# @seed_data_by_hash={"data1"=>{"id"=>1, "name"=>"one"}}>
+
+# Instance is holding original seed.
+@table.original_seed == original_seed
+# => true
+```
+### Example of `AccessibleSeedYaml::Record`
+```ruby
+@recoed = @table.records[0]
+
+@recoed
+# => #<AccessibleSeedYaml::Record:0x007f9155725068
+#     @original_seed="data1:\n  id: 1\n  name: \"one\"\n",
+#     @seed_data_by_hash={"data1"=>{"id"=>1, "name"=>"one"}}>
+
+# Instance is providing data access interface.
+@recoed.attributes          # => {"id"=>1, "name"=>"one"}
+@recoed.attributes["id"]    # => 1
+@recoed.attributes["name"]  # => "one"
+
+# Instance is holding original seed.
+@recoed.original_seed # => "data1:\n  id: 1\n  name: \"one\"\n"
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+end

data/accessible_seed_yaml.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accessible_seed_yaml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "accessible_seed_yaml"
+  spec.version       = AccessibleSeedYaml::VERSION
+  spec.authors       = ["Shinya131"]
+  spec.email         = ["nagai3mt5b@gmail.com"]
+  spec.summary       = "AccessibleSeedYaml is wrapper of rails seed file."
+  spec.description   = "AccessibleSeedYaml is wrapper of rails seed file. This wrapper provides following function: 1. Easy access interface for seed data. 2. Hold original seed data."
+  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", "~> 10.0"
+end

data/lib/accessible_seed_yaml/record.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+module AccessibleSeedYaml
+  # This class is wrapper of seed for one record.
+  #   Functions:
+  #    - Fetch seed attributes by hash.
+  #    - Stored original seed string. It can fetch anytime.
+  class Record
+    attr_reader :original_seed
+    
+    # @param [String] seed_for_one_record seed string for one record.
+    # @raise [ArgumentError] if argument has not only one key then raise.
+    # @example
+    #  <Correct>
+    #  ````
+    #  data1:
+    #    id: 1
+    #    name: "one"
+    #  ````
+    #   => this is one record.
+    #
+    #  <Wrong>
+    #  ````
+    #  data1:
+    #    id: 1
+    #    name: "one"
+    #  data2:
+    #    id: 2
+    #    name: "two"
+    #  ````
+    #   => this is tow record.
+    #
+    def initialize(seed_for_one_record)
+      @original_seed = seed_for_one_record
+      exchange_to_hash
+    end
+    
+    # @return [Hash] attributes of seed data by hash.
+    # @example
+    #  <source>
+    #  data1:
+    #    id: 1
+    #    name: "one"
+    #
+    #  <return>
+    #  {"id" => 1, "name" => "one"}
+    def attributes
+      @seed_data_by_hash.values.first
+    end
+    
+    private
+    
+    def exchange_to_hash
+      @seed_data_by_hash ||= YAML.load(@original_seed)
+      
+      unless @seed_data_by_hash.size == 1
+        raise ArgumentError.new('original_seed key size is not 1.')
+      end
+    end
+  end
+end

data/lib/accessible_seed_yaml/table.rb

@@ -0,0 +1,73 @@
+# This module has seed wrapper classes.
+# Those wrapper provides following function:
+# 1. Easy access interface for seed data.
+# 2. Hold original seed data.
+module AccessibleSeedYaml
+  # This class is wrapper of seed.  
+  #   Functions:
+  #    - Fetch seed data by record unit.
+  #    - Stored original seed string. It can fetch anytime.
+  class Table
+    attr_reader :original_seed
+    
+    # @param [String] seed for data source.
+    def initialize(seed)
+      @original_seed = seed
+    end
+    
+    # @return [Array of AccessibleSeedYaml::Record] seed data. It split by record unit.
+    # @example
+    #
+    #  <source data>
+    #  data1:
+    #    id: 1
+    #    name: "one"
+    #  data2:
+    #    id: 2
+    #    name: "two"
+    #
+    #  <return>
+    #  [
+    #   #<AccessibleSeedYaml::Record:0x007f91552770c0
+    #    @original_seed="data1:\n  id: 1\n  name: \"one\"\n",
+    #    @seed_data_by_hash={"data1"=>{"id"=>1, "name"=>"one"}}>,
+    #   #<AccessibleSeedYaml::Record:0x007f915526c238
+    #    @original_seed="data2:\n  id: 2\n  name: \"two\"\n",
+    #    @seed_data_by_hash={"data2"=>{"id"=>2, "name"=>"two"}}>,
+    #  ]
+    def records
+      setup_records if @records.nil?
+      @records
+    end
+    
+    private
+    
+    def setup_records
+      @records = []
+      seed = @original_seed.dup
+      
+      loop do
+        if seed.empty?
+          break
+        end
+        
+        record = Record.new(fetch_first_record!(seed))
+        @records << record
+      end
+    end
+    
+    def fetch_first_record!(seed)
+      record_boader = seed.index(record_boader_regexp)
+   
+      if record_boader.nil?
+        return seed.slice!(0..-1)
+      end
+   
+      seed.slice!(0..record_boader)
+    end
+    
+    def record_boader_regexp
+      /\n[^ ]/
+    end
+  end
+end

data/lib/accessible_seed_yaml/version.rb

@@ -0,0 +1,3 @@
+module AccessibleSeedYaml
+  VERSION = "1.0.0"
+end

data/lib/accessible_seed_yaml.rb

@@ -0,0 +1,6 @@
+require "accessible_seed_yaml/version"
+
+module AccessibleSeedYaml
+  require "accessible_seed_yaml/table"
+  require "accessible_seed_yaml/record"
+end

data/test/accessible_seed/test_record.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+MiniTest::Unit.autorun
+
+class TestRecord < MiniTest::Unit::TestCase
+  def setup
+    @record = AccessibleSeedYaml::Record.new(TestData::Seed::Record01)
+  end
+  
+  def test_initialize
+    assert_raises(ArgumentError){ AccessibleSeedYaml::Record.new(TestData::Seed::Table) }
+  end
+  
+  def test_original_seed
+    assert_equal(TestData::Seed::Record01, @record.original_seed)
+  end
+  
+  def test_records
+    assert_equal(1,        @record.attributes["id"])
+    assert_equal("coffee", @record.attributes["name"])
+  end
+end

data/test/accessible_seed/test_table.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+MiniTest::Unit.autorun
+
+class TestTable < MiniTest::Unit::TestCase
+  def setup
+    @seed = AccessibleSeedYaml::Table.new(TestData::Seed::Table)
+  end
+  
+  def test_original_seed
+    assert_equal(TestData::Seed::Table, @seed.original_seed)
+  end
+  
+  def test_records
+    assert_instance_of(AccessibleSeedYaml::Record, @seed.records.first)
+    
+    assert_equal(TestData::Seed::Record01, @seed.records[0].original_seed)
+    assert_equal(TestData::Seed::Record02, @seed.records[1].original_seed)
+    assert_equal(TestData::Seed::Record03, @seed.records[2].original_seed)
+  end
+end

data/test/test_data.rb

@@ -0,0 +1,31 @@
+module TestData
+  module Seed
+    Record01 =
+    [
+      "data1:\n",
+      "  id: 1\n",
+      "  name: \"coffee\"\n"
+    ].join
+    
+    Record02 =
+    [
+      "data2:\n",
+      "  id: 2\n",
+      "  name: \"tea\"\n"
+    ].join
+    
+    Record03 =
+    [
+      "data3:\n",
+      "  id: 3\n",
+      "  name: \"water\"\n"
+    ].join
+      
+    Table =
+    [
+      Record01,
+      Record02,
+      Record03
+    ].join
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# coveralls
+require 'coveralls'
+Coveralls.wear!
+
+# minitest
+require 'minitest/unit'
+
+# require all lib files
+Dir[File.expand_path('../../lib/**/', __FILE__) << '/*.rb'].each do |file|
+  require file
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: accessible_seed_yaml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shinya131
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'AccessibleSeedYaml is wrapper of rails seed file. This wrapper provides
+  following function: 1. Easy access interface for seed data. 2. Hold original seed
+  data.'
+email:
+- nagai3mt5b@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accessible_seed_yaml.gemspec
+- lib/accessible_seed_yaml.rb
+- lib/accessible_seed_yaml/record.rb
+- lib/accessible_seed_yaml/table.rb
+- lib/accessible_seed_yaml/version.rb
+- test/accessible_seed/test_record.rb
+- test/accessible_seed/test_table.rb
+- test/test_data.rb
+- test/test_helper.rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: AccessibleSeedYaml is wrapper of rails seed file.
+test_files:
+- test/accessible_seed/test_record.rb
+- test/accessible_seed/test_table.rb
+- test/test_data.rb
+- test/test_helper.rb
+has_rdoc: