harshed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 460df5ea911680f7ee2a14085d74db9495668bec
+  data.tar.gz: fce9d965d4c8f17e70803a98f4363b4617854123
+SHA512:
+  metadata.gz: a56f3abc51a067ca7a054c499218654976c2686b52d8f3651fc2580e953b12ca14d489d9b43dc344ab5033a560c11b60b0bf7b3e1fd2d3c0e62397eb5afe606c
+  data.tar.gz: 55756d0abc54b57510619c59c8918e35107186a703bdd23f6573706aed33bfb9dde10ab1ee96f7958d58d813afcfe31cd377be792c135fff47acc0016ae00217

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 22
+
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Max: 120
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/StructInheritance:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+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'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Baker
+
+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,56 @@
+# Harshed
+
+Ruby Serializable Hashed Array Utility
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'harshed'
+```
+
+And then execute:
+
+    $> bundle
+
+Or install it yourself as:
+
+    $> gem install harshed
+
+## Usage
+
+      class Character
+        attr_reader :character_name, :strength, :dexterity, :constitution, :wisdom, :intelligence, :charisma
+    
+        def initialize(character_name)
+          @character_name = character_name
+          @strength = 10
+          @dexterity = 10
+          @constitution = 10
+          @wisdom = 10
+          @intelligence = 10
+          @charisma = 10
+        end
+      end
+      
+      @heroes = Harshed.new(:character_name, storage_folder: 'characters')
+      
+      sir_fumblealot = Character.new('SirFumbleAlot')
+      stinky = Character.new('StinkyTheBeggar')
+      
+      @heroes.store([sir_fumblealot, stinky])
+      
+      @heroes.to_disk
+      
+      @heroes_reborn = Harshed.new(:character_name, storage_folder: 'characters').from_disk
+                 
+## Development
+
+To run tests, Reek, and RubyCop:
+
+    $> rake boom 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/folkengine/harshed.

data/Rakefile

@@ -0,0 +1,26 @@
+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/data/.gitignore

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

data/harshed.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'harshed'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'harshed'
+  spec.version       = Harshed::VERSION
+  spec.authors       = ['Folkengine']
+  spec.email         = ['gaoler@electronicpanopticon.com']
+
+  spec.summary       = 'Ruby Serializable Hashed Array Utility'
+  spec.description   = ''
+  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'
+end

data/lib/harshed.rb

@@ -0,0 +1,102 @@
+require 'fileutils'
+require 'yamlable'
+
+# 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
+
+  def self.default_base_folder
+    File.join(File.dirname(__FILE__), '..', 'data')
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: harshed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Folkengine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: ''
+email:
+- gaoler@electronicpanopticon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/.gitignore
+- harshed.gemspec
+- lib/harshed.rb
+homepage: https://github.com/folkengine/harshed
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Serializable Hashed Array Utility
+test_files: []