shrift 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ffd10c8e7f662dcd01939712e0f864dd5b6e159
-  data.tar.gz: 12153ba532ac676cfa55daeb6b017822c6427831
+  metadata.gz: e4bfec4ab473bf34570817c08cc69a55c2768bb9
+  data.tar.gz: 3a23d7520579fdb6f9cdd3a407f5ba10ed4bc51e
 SHA512:
-  metadata.gz: 939ae77dd4dc6b30b350b6d9bd4467d5533d61a8b9ea6a3d891370eb6ffe402d83acff3edce152dfd7c3d006082225d6783b423053c7db4aa2dceb19067b2ad8
-  data.tar.gz: 39c347c5b630b14d98a6a623ed4b3aae6ad65593d4195b39de7e993a62f0ecc2a6974e16bed2960cbfb2a6e771c9c5284455037859b1c4c0403b5fee61a5397a
+  metadata.gz: 8f8d933bb61710667bf5fc28dd87fd99513a3f4b26aac25910077499254d13221304db858244a231b9f6d6f6af0bab38861705906c2bea3868904b649fa3721f
+  data.tar.gz: 8ce25d22f9767651723117765a5cfbd72f3b1354a03d12da2b7c2212440cdec2045a79bb79ece918bcf569d8ba4fd9d50584a76902f8562a3284f5c51340c95e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shrift (0.0.1)
+    shrift (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,6 @@
 # Shrift
 
+[![Gem Version](https://badge.fury.io/rb/shrift.svg)](https://badge.fury.io/rb/shrift)
 [![Build Status](https://travis-ci.org/folkengine/shrift.svg?branch=master)](https://travis-ci.org/folkengine/shrift)
 
 Makes short shrift of objects. 
@@ -10,6 +11,18 @@ This is alpha software and only works with basic Objects.
 
 Shrift is a simple DSL generator that turns Objects to single line Strings for easy storage and debugging. 
 
+An example 'Shrift String' would be:
+
+    example:st15dx14cn10w18i3ch6:4
+
+When you split the String on ':', this first cell is a String, the second cell is a 'Shrift Map' of alternating
+field shorthand Strings and integers, and the third cell maps to an integer. 
+
+Pass this String back into the Shrift object configured to make short shrift of the class and it will return the Object,
+good as new.
+
+I created this so that I had a way to pack as much informational punch into as short a space as possible.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/shrift/shrift_map.rb

@@ -6,24 +6,24 @@ require_relative 'shrift_exception'
 # Shrift map keys are lowercase.
 #
 class ShriftMap
-  attr_reader :hashmap, :shrift_map_string
+  attr_reader :schema, :shrift_map_string
 
   def initialize(shrift_map_string)
     @shrift_map_string = shrift_map_string
-    @hashmap = {}
+    @schema = {}
     split(shrift_map_string)
   end
 
   def fetch(key)
-    @hashmap[key.downcase.to_sym].to_i
+    @schema[key.downcase.to_sym].to_i
   end
 
   def store(key, value)
-    @hashmap[key.downcase.to_sym] = value.to_i
+    @schema[key.downcase.to_sym] = value.to_i
   end
 
   def to_hash
-    @hashmap
+    @schema
   end
 
   def to_s

data/lib/shrift/shrift_mapper.rb

@@ -2,38 +2,38 @@ require_relative 'shrift_map'
 
 # I map ShriftMaps
 class ShriftMapper
-  attr_reader :hashmap
+  attr_reader :schema
 
-  def initialize(hashmap: {})
-    @hashmap = hashmap
+  def initialize(schema: {})
+    @schema = schema
     clean
   end
 
   def fetch(key)
-    @hashmap[key.downcase.to_sym]
+    @schema[key.downcase.to_sym]
   end
 
   def store(key, value)
-    @hashmap[key] = value
+    @schema[key] = value
   end
 
   def parse(shrift_map_string)
     hash = {}
-    ShriftMap.new(shrift_map_string).hashmap.each do |key, val|
-      hash[@hashmap[key]] = val
+    ShriftMap.new(shrift_map_string).schema.each do |key, val|
+      hash[@schema[key]] = val
     end
     hash
   end
 
   def to_hash
-    @hashmap
+    @schema
   end
 
   # :reek:UncommunicativeVariableName :reek:FeatureEnvy
   def to_shrift_string(mappie)
     return mappie if mappie.is_a?(String)
-    return mappie.map { |k, v| @hashmap.key(k).to_s.downcase + v.to_s }.join if mappie.is_a?(Hash)
-    @hashmap.map { |k, v| k.to_s.downcase + mappie.send(v).to_s }.join
+    return mappie.map { |k, v| @schema.key(k).to_s.downcase + v.to_s }.join if mappie.is_a?(Hash)
+    @schema.map { |k, v| k.to_s.downcase + mappie.send(v).to_s }.join
   end
 
   def to_shrift_map(mappie)
@@ -49,13 +49,13 @@ class ShriftMapper
   # :reek:UncommunicativeVariableName
   def set(value, target)
     shrift_map = to_shrift_map(value)
-    @hashmap.map { |k, v| target.send("#{v}=", shrift_map.fetch(k)) }
+    @schema.map { |k, v| target.send("#{v}=", shrift_map.fetch(k)) }
   end
 
   private
 
   # Convert Hash keys to symbols
   def clean
-    @hashmap = Hash[@hashmap.map { |key, value| [key.downcase.to_sym, value] }]
+    @schema = Hash[@schema.map { |key, value| [key.downcase.to_sym, value] }]
   end
 end

data/lib/shrift/shrift_version.rb

@@ -1,3 +1,3 @@
 class ShriftVersion
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrift
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Folkengine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler