harshed 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 460df5ea911680f7ee2a14085d74db9495668bec
-  data.tar.gz: fce9d965d4c8f17e70803a98f4363b4617854123
+  metadata.gz: 28bb5bf44b780690fbbe646c505cb02f0bc7ef38
+  data.tar.gz: a9aa91b9e408e57a8bedd5da138a4c60fbcffe77
 SHA512:
-  metadata.gz: a56f3abc51a067ca7a054c499218654976c2686b52d8f3651fc2580e953b12ca14d489d9b43dc344ab5033a560c11b60b0bf7b3e1fd2d3c0e62397eb5afe606c
-  data.tar.gz: 55756d0abc54b57510619c59c8918e35107186a703bdd23f6573706aed33bfb9dde10ab1ee96f7958d58d813afcfe31cd377be792c135fff47acc0016ae00217
+  metadata.gz: 8d415cbe289df4e384241b06d3cda246482d49f0fe4f485af1d5b74ebc86c1b81fdf037e2a85a17901dd70e1b93480cd5b82d77feae89a9feffbf12e9c615a2c
+  data.tar.gz: 76f166a66a44a80c111db5a2ca3fcc20daa40f2bc663338d3f0cb7c4903c946d616c232e5df738e7babfee38fc4b38ad0c7bebec3cca1f071f9befbac1f97ccb

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/.idea/
+/.idea/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - "2.1.5"
+ - "2.2.0"

data/Gemfile

@@ -3,12 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in harshed.gemspec
 gemspec
 
-gem 'faker'
-gem 'yamlable'
-
 group :development do
   gem 'minitest'
   gem 'minitest-reporters'
-  gem 'reek'
-  gem 'rubocop'
+  gem 'faker'
 end

data/README.md

@@ -1,7 +1,25 @@
 # Harshed
 
+[![Gem Version](https://badge.fury.io/rb/harshed.svg)](https://badge.fury.io/rb/harshed)
+[![Build Status](https://travis-ci.org/folkengine/harshed.svg?branch=master)](https://travis-ci.org/folkengine/harshed)
+
 Ruby Serializable Hashed Array Utility
 
+A Harsh is a hashed array that can be quickly written to and read from disk in a format that can be easily reviewed. 
+Take a collection of same type objects. Pick a pivot point, aka, a field unique to each object that can be used as the key 
+for the hash. 
+
+I wrote this module to support development/testing techniques that I've grown use to. As a developer I am squarely in the 
+[classical, anti-mockist camp](https://agilewarrior.wordpress.com/2015/04/18/classical-vs-mockist-testing/). Harshed helps with that.
+
+Eventually, I'd like to update this module to support the following features:
+
+1. Support for JSON
+2. Support for XML
+3. Ability to pivot on a field not in the object being serialized.
+4. Harshed DB support
+5. Deal with the sure to be their defect of spaces on the pivot field
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,13 +61,14 @@ Or install it yourself as:
       
       @heroes.to_disk
       
-      @heroes_reborn = Harshed.new(:character_name, storage_folder: 'characters').from_disk
+      @heroes_reborn = Harshed.new(:character_name, storage_folder: 'characters')
+                           .from_disk
                  
 ## Development
 
-To run tests, Reek, and RubyCop:
+To run tests:
 
-    $> rake boom 
+    $> rake 
 
 ## Contributing
 

data/Rakefile

@@ -1,26 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'reek/rake/task'
-require 'rubocop/rake_task'
 
 task default: :test
 
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = false
-end
-
-RuboCop::RakeTask.new
-
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList['test/**/test*.rb']
   t.verbose = true
 end
-
-task :boom do
-  Rake::Task['test'].execute
-  puts 'Running Reek...'
-  Rake::Task['reek'].execute
-  puts
-  Rake::Task['rubocop'].execute
-end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "harshed"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/.gitignore

@@ -1,2 +1,2 @@
-.yml
-.yaml
+*.yml
+*.yaml

data/harshed.gemspec

@@ -1,20 +1,22 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'harshed'
+require 'harshed/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'harshed'
   spec.version       = Harshed::VERSION
   spec.authors       = ['Folkengine']
   spec.email         = ['gaoler@electronicpanopticon.com']
+  spec.license       = 'MIT'
 
   spec.summary       = 'Ruby Serializable Hashed Array Utility'
-  spec.description   = ''
+  spec.description   = 'Utility to quickly save and retrieve objects from disk'
   spec.homepage      = 'https://github.com/folkengine/harshed'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'yamlable', '>= 0.0.2'
+  spec.add_development_dependency 'bundler', '>= 1.7.6'
+  spec.add_development_dependency 'rake', "~> 10.0"
 end

data/lib/harshed.rb

@@ -1,101 +1,10 @@
 require 'fileutils'
 require 'yamlable'
+require 'harshed/harsh'
+require 'harshed/version'
 
 # Ruby Serializable Hashed Array Utility
-class Harshed
-  include Yamlable
-
-  VERSION = '0.1.0'.freeze
-
-  attr_reader :hash, :key_to_map
-
-  def initialize(key_to_map, items = [],
-                 storage_base: Harshed.default_base_folder,
-                 storage_folder: '')
-    @key_to_map = key_to_map
-    @hash = {}
-    @storage_folder = storage_folder
-    @storage_base = storage_base
-    store(items)
-  end
-
-  def store(items)
-    # Hack to get around how Array() mangles Hashes and Structs
-    if items.is_a?(Array)
-      items.each { |item| store_item(item) }
-    else
-      store_item(items)
-    end
-  end
-
-  def store_item(item)
-    validate_type(item)
-    @hash[item.send(@key_to_map)] = item
-  end
-
-  def valid_type?(item)
-    @hash.values.last.class == item.class
-  end
-
-  def validate_type(item)
-    return if @hash.empty?
-    unless valid_type?(item)
-      raise TypeError "Harshed Object class types (#{last_class}/#{item_class}) must be the same."
-    end
-  end
-
-  def to_a
-    @hash.values
-  end
-
-  def key?(key)
-    @hash.key?(key)
-  end
-
-  def value(my_key)
-    @hash[my_key]
-  end
-
-  def sample
-    @hash.values.sample
-  end
-
-  def from_disk
-    Dir["#{folder_path}/*.yml"].each do |filename|
-      yml = File.read(filename)
-      store(Psych.load(yml, filename))
-    end
-    self
-  end
-
-  # This method smells of :reek:NestedIterators
-  def to_disk
-    mkdir
-    @hash.each do |key, value|
-      File.open(filename(key), 'w') { |file| file.write(value.to_yaml) }
-    end
-  end
-
-  def mkdir
-    Dir.mkdir(folder_path) unless Dir.exist?(folder_path)
-  end
-
-  def rm_r
-    FileUtils.remove_dir folder_path
-  end
-
-  def folder_path
-    if @storage_folder.empty?
-      File.join(@storage_base, @hash.values.first.class.to_s)
-    else
-      File.join(@storage_base, @storage_folder)
-    end
-  end
-
-  def filename(key)
-    File.join(folder_path, "#{key}.yml")
-  end
-
+module Harshed
   def self.default_base_folder
     File.join(File.dirname(__FILE__), '..', 'data')
   end

data/lib/harshed/harsh.rb

@@ -0,0 +1,95 @@
+# Ruby Serializable Hashed Array Utility
+module Harshed
+  class Harsh
+    include Yamlable
+
+    attr_reader :hash, :key_to_map
+
+    def initialize(key_to_map, items = [],
+                   storage_base: Harshed.default_base_folder,
+                   storage_folder: '')
+      @key_to_map = key_to_map
+      @hash = {}
+      @storage_folder = storage_folder
+      @storage_base = storage_base
+      store(items)
+    end
+
+    def store(items)
+      # Hack to get around how Array() mangles Hashes and Structs
+      if items.is_a?(Array)
+        items.each { |item| store_item(item) }
+      else
+        store_item(items)
+      end
+    end
+
+    def store_item(item)
+      validate_type(item)
+      @hash[item.send(@key_to_map)] = item
+    end
+
+    def valid_type?(item)
+      @hash.values.last.class == item.class
+    end
+
+    def validate_type(item)
+      return if @hash.empty?
+      unless valid_type?(item)
+        raise TypeError "Harshed Object class types (#{last_class}/#{item_class}) must be the same."
+      end
+    end
+
+    def to_a
+      @hash.values
+    end
+
+    def key?(key)
+      @hash.key?(key)
+    end
+
+    def value(my_key)
+      @hash[my_key]
+    end
+
+    def sample
+      @hash.values.sample
+    end
+
+    def from_disk
+      Dir["#{folder_path}/*.yml"].each do |filename|
+        yml = File.read(filename)
+        store(Psych.load(yml, filename))
+      end
+      self
+    end
+
+    # This method smells of :reek:NestedIterators
+    def to_disk
+      mkdir
+      @hash.each do |key, value|
+        File.open(filename(key), 'w') { |file| file.write(value.to_yaml) }
+      end
+    end
+
+    def mkdir
+      Dir.mkdir(folder_path) unless Dir.exist?(folder_path)
+    end
+
+    def rm_r
+      FileUtils.remove_dir folder_path
+    end
+
+    def folder_path
+      if @storage_folder.empty?
+        File.join(@storage_base, @hash.values.first.class.to_s)
+      else
+        File.join(@storage_base, @storage_folder)
+      end
+    end
+
+    def filename(key)
+      File.join(folder_path, "#{key}.yml")
+    end
+  end
+end

data/lib/harshed/version.rb

@@ -0,0 +1,3 @@
+module Harshed
+  VERSION = '0.1.2'.freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harshed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Folkengine
@@ -10,20 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yamlable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.7.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: ''
+description: Utility to quickly save and retrieve objects from disk
 email:
 - gaoler@electronicpanopticon.com
 executables: []
@@ -47,15 +61,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - data/.gitignore
 - harshed.gemspec
 - lib/harshed.rb
+- lib/harshed/harsh.rb
+- lib/harshed/version.rb
 homepage: https://github.com/folkengine/harshed
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []