shrift 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b30b6e4d8482529d44dd7e2eab9d4f5a7b9d4780
-  data.tar.gz: 113a2e6080990929fce5a4d83ee52edfc6825aa9
+  metadata.gz: 1ffd10c8e7f662dcd01939712e0f864dd5b6e159
+  data.tar.gz: 12153ba532ac676cfa55daeb6b017822c6427831
 SHA512:
-  metadata.gz: 99f31f6c54bedeb9efbf2bfe307d3ff8c8e626e16de059700c008484b0e47d92c9faf83c6df505cbc0b20c5db88be6556beedb12b331367eea36d8161878192a
-  data.tar.gz: 44745b162d371fe0ed813a13554458fd3dc5bf3492358a0bd89c159f703ec0d3418efef68d6eb8e8f8255538f92b9a666218a4935ffffff898cb21975488a6a0
+  metadata.gz: 939ae77dd4dc6b30b350b6d9bd4467d5533d61a8b9ea6a3d891370eb6ffe402d83acff3edce152dfd7c3d006082225d6783b423053c7db4aa2dceb19067b2ad8
+  data.tar.gz: 39c347c5b630b14d98a6a623ed4b3aae6ad65593d4195b39de7e993a62f0ecc2a6974e16bed2960cbfb2a6e771c9c5284455037859b1c4c0403b5fee61a5397a

data/.rubocop.yml

@@ -0,0 +1,23 @@
+# 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'
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/IndentHash:
+  Enabled: false
+
+Style/MethodLength:
+  Enabled: false

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
  - "2.1.5"
  - "2.2.0"
+ - "2.3.1"

data/Gemfile

@@ -8,4 +8,5 @@ group :development do
   gem 'minitest-reporters'
   gem 'reek'
   gem 'rubocop'
+  gem 'yamlable'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shrift (0.0.0)
+    shrift (0.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -50,6 +50,7 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
+    yamlable (0.0.2)
 
 PLATFORMS
   ruby
@@ -62,6 +63,7 @@ DEPENDENCIES
   reek
   rubocop
   shrift!
+  yamlable
 
 BUNDLED WITH
-   1.11.2
+   1.12.3

data/README.md

@@ -2,9 +2,13 @@
 
 [![Build Status](https://travis-ci.org/folkengine/shrift.svg?branch=master)](https://travis-ci.org/folkengine/shrift)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shrift`. To experiment with that code, run `bin/console` for an interactive prompt.
+Makes short shrift of objects. 
 
-TODO: Delete this and the text above, and describe your gem
+## Warning
+
+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. 
 
 ## Installation
 
@@ -24,7 +28,55 @@ Or install it yourself as:
 
 ## Usage
 
-It don't use right.
+Given a simple class: 
+
+```ruby
+class Character
+  attr_accessor :character_name, :strength, :dexterity,
+                :constitution, :wisdom, :intelligence, :charisma, :hit_points
+
+  def initialize(character_name = '')
+    @character_name = character_name
+  end
+end
+```
+
+I setup a Shrift that maps the first cell  to character_name, the second cell to a ShriftMap of most of the integer 
+fields, and the third field mapped as an integer to hit_points:
+
+```ruby
+shrift_mapper = ShriftMapper.new(hashmap: {
+        ST: 'strength',
+        DX: 'dexterity',
+        CN: 'constitution',
+        W: 'wisdom',
+        I: 'intelligence',
+        CH: 'charisma'})
+shrift = Shrift.new(Character, [ShriftCell.new(:character_name), shrift_mapper, ShriftInt.new(:hit_points)])
+
+bub = Character.new('bub')
+bub.strength = 15
+bub.dexterity = 14
+bub.constitution = 10
+bub.wisdom = 18
+bub.intelligence = 3
+bub.charisma = 6
+bub.hit_points = 4
+
+bubbu_shrift = shrift.short(bub)
+```
+
+This returns a Shrift String of:
+ 
+```ruby
+bub:st15dx14cn10w18i3ch6:4
+```
+
+To turn it back into an Object, I just need to pass the Shrift String into the Shrift's classify method:
+
+```ruby
+new_bub = @shrift.classify(bubbu_shrift)
+```
 
 ## Development
 

data/lib/shrift/shrift_cell.rb

@@ -0,0 +1,16 @@
+# A basic Shrift Cell mapping to a String.
+class ShriftCell
+  attr_reader :field
+
+  def initialize(field)
+    @field = field
+  end
+
+  def process(target)
+    target.send(field)
+  end
+
+  def set(value, target)
+    target.send("#{@field}=", value)
+  end
+end

data/lib/shrift/shrift_exception.rb

@@ -0,0 +1,3 @@
+# An Exception thrown when a Shrift string doesn't cut it.
+class ShriftException < Exception
+end

data/lib/shrift/shrift_int.rb

@@ -0,0 +1,12 @@
+require_relative('shrift_cell')
+
+# A Shrift Cell where the value is in integer.
+class ShriftInt < ShriftCell
+  def process(target)
+    target.send(field)
+  end
+
+  def set(value, target)
+    target.send("#{@field}=", value.to_i)
+  end
+end

data/lib/shrift/shrift_map.rb

@@ -1,26 +1,59 @@
-module Shrift
-  class ShriftMap
-    attr_accessor :default, :map
-    attr_reader :shrift_map_string
-
-    def initialize(shrift_map_string, default = nil)
-      @default = default
-      @shrift_map_string = shrift_map_string
-      parse(shrift_map_string)
-    end
+require_relative 'shrift_exception'
 
-    def fetch(key)
-      map[key]
-    end
+# A String that alternates between characters and numbers. Short hand for a collection
+# of variables that hold integer values.
+#
+# Shrift map keys are lowercase.
+#
+class ShriftMap
+  attr_reader :hashmap, :shrift_map_string
 
-    def store(key, value)
-      map[key] = value
-    end
+  def initialize(shrift_map_string)
+    @shrift_map_string = shrift_map_string
+    @hashmap = {}
+    split(shrift_map_string)
+  end
+
+  def fetch(key)
+    @hashmap[key.downcase.to_sym].to_i
+  end
+
+  def store(key, value)
+    @hashmap[key.downcase.to_sym] = value.to_i
+  end
 
-    private
+  def to_hash
+    @hashmap
+  end
+
+  def to_s
+    @shrift_map_string
+  end
+
+  def self.to_shrift_map(hash)
+    ShriftMap.new(ShriftMap.to_shrift_map_string(hash))
+  end
+
+  def self.to_shrift_map_string(hash)
+    shrift_map_string = ''
+    hash.each do |key, val|
+      shrift_map_string << key.to_s
+      shrift_map_string << val.to_s
+    end
+    shrift_map_string
+  end
 
-    def parse(shrift_map_string)
+  private
 
+  def split(shrift_map_string)
+    until shrift_map_string.empty?
+      shrift_group = shrift_map_string.scan(/^([a-zA-Z]+)(\d+)(.*)/).first
+      begin
+        store(shrift_group[0], shrift_group[1])
+      rescue NoMethodError
+        raise ShriftException, "Unbalanced ShriftMap: #{@shrift_map_string}"
+      end
+      shrift_map_string = shrift_group[2]
     end
   end
 end

data/lib/shrift/shrift_mapper.rb

@@ -0,0 +1,61 @@
+require_relative 'shrift_map'
+
+# I map ShriftMaps
+class ShriftMapper
+  attr_reader :hashmap
+
+  def initialize(hashmap: {})
+    @hashmap = hashmap
+    clean
+  end
+
+  def fetch(key)
+    @hashmap[key.downcase.to_sym]
+  end
+
+  def store(key, value)
+    @hashmap[key] = value
+  end
+
+  def parse(shrift_map_string)
+    hash = {}
+    ShriftMap.new(shrift_map_string).hashmap.each do |key, val|
+      hash[@hashmap[key]] = val
+    end
+    hash
+  end
+
+  def to_hash
+    @hashmap
+  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
+  end
+
+  def to_shrift_map(mappie)
+    ShriftMap.new(to_shrift_string(mappie))
+  end
+
+  # Shrift Cell Methods
+
+  def process(target)
+    to_shrift_string(target)
+  end
+
+  # :reek:UncommunicativeVariableName
+  def set(value, target)
+    shrift_map = to_shrift_map(value)
+    @hashmap.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] }]
+  end
+end

data/lib/shrift/shrift_version.rb

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

data/lib/shrift.rb

@@ -1,9 +1,30 @@
-require 'shrift/version'
-require 'shrift/shriftlet'
+require 'shrift/shrift_cell'
+require 'shrift/shrift_int'
 require 'shrift/shrift_map'
+require 'shrift/shrift_mapper'
 
-module Shrift
-  class Short
+# Making short shrift of Objects.
+class Shrift
+  attr_reader :clazz
 
+  def initialize(clazz, guide = [])
+    @clazz = clazz
+    @guide = guide
+  end
+
+  # Turns the target class into a Shrift String
+  def short(target)
+    @guide.map { |cell| cell.process(target) }.join(':')
+  end
+
+  def classify(shrift_string)
+    zippy = @guide.zip(shrift_string.split(':'))
+    objective = Object.const_get(clazz.to_s).new
+
+    zippy.each do |cell|
+      cell[0].set(cell[1], objective)
+    end
+
+    objective
   end
 end

data/shrift.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'shrift/version'
+require 'shrift/shrift_version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'shrift'
-  spec.version       = Shrift::VERSION
+  spec.version       = ShriftVersion::VERSION
   spec.authors       = ['Folkengine']
   spec.email         = ['gaoler@electronicpanopticon.com']
 
-  spec.summary       = 'WORK IN PROGRESS - Ruby utility library to make short shrift of objects.'
+  spec.summary       = 'Ruby utility library to make short shrift of objects.'
   spec.description   = 'Custom object serializer DSL'
   spec.homepage      = 'https://github.com/folkengine/shrift'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrift
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Folkengine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -53,9 +54,12 @@ files:
 - README.md
 - Rakefile
 - lib/shrift.rb
+- lib/shrift/shrift_cell.rb
+- lib/shrift/shrift_exception.rb
+- lib/shrift/shrift_int.rb
 - lib/shrift/shrift_map.rb
-- lib/shrift/shriftlet.rb
-- lib/shrift/version.rb
+- lib/shrift/shrift_mapper.rb
+- lib/shrift/shrift_version.rb
 - shrift.gemspec
 homepage: https://github.com/folkengine/shrift
 licenses: []
@@ -76,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: WORK IN PROGRESS - Ruby utility library to make short shrift of objects.
+summary: Ruby utility library to make short shrift of objects.
 test_files: []

data/lib/shrift/shriftlet.rb

@@ -1,5 +0,0 @@
-module Shrift
-  class Shriftlet
-
-  end
-end

data/lib/shrift/version.rb

@@ -1,3 +0,0 @@
-module Shrift
-  VERSION = '0.0.0'.freeze
-end