thyng 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4c7db9aae62d6681d2dd971af42314dc2ea35fc
+  data.tar.gz: 9034618eaa475198878a3118f98cc4c0fef811f3
+SHA512:
+  metadata.gz: ea41f1e43df85be3bdd184e86bc6fd8312fec68d9c6712658eeaf30e3169b1b57e0055a9e56220ec42e8db723edaa515fa937cbfc9d4820065b3b3e439b86af5
+  data.tar.gz: 96cda3cee7960ec56f2950770977266a3ea920dce091ade504f334d024ca2190a4cdb4314231c53b3dbd97d4c6207ca3a325c553e4872c17de208ef5189d5a02

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thyng.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Saxton
+
+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,81 @@
+# Thyng
+
+##### Ruby objects with public state to encourage storage as data only collections.
+
+### What?
+A `thyng` is a ruby object with the convention of saving state in **key:value** pairs that are public on the object rather than in private **instance variables**.
+
+### How?
+Instead of private attributes a `thyng` has public aspects. Basic access to these can be declared with `asect_reader`, `aspect_write` & `aspect_accessor`.
+
+### Why?
+Will all internal state a `thyng` can be reconstructed completly from its data. This allows it to be passed as JSON a json object and easily be stored in a database.
+
+### Simple example
+
+```ruby
+class Person < Thyng
+  aspect_accessor :name
+end
+
+person = Person.new
+# => {}
+
+person.name = 'Fester'
+
+puts person
+# => {name: 'Fester'}
+``` 
+
+### Show me the money
+*Thyng objects are subclassed from ruby hashes. This means most database orm's know exactly how handle them*
+
+```ruby
+class Person < Thyng
+  aspect_accessor :name
+  aspect_accessor :age
+end
+
+class Credentials < Thyng
+  aspect_accessor :email
+  crypted_accessor :password # <- Oooh!
+end
+
+person = Person.new name: 'Morticia', age: '41'
+credentials = Credentials.new email: 'm@addams.biz', password: 'password'
+
+record = Record.last
+
+record.set person
+record.set credentials
+
+record.save
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thyng'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thyng
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/thyng/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/thyng.rb

@@ -0,0 +1,26 @@
+require "thyng/version"
+
+class Thyng < Hash
+  def initialize(args={})
+    args.each{ |attribute, value|
+      send("#{attribute}=", value)
+    }
+  end
+  
+  def self.aspect_writer aspect
+    define_method "#{aspect}=", ->(value) {
+      self[aspect] = value
+    }
+  end
+
+  def self.aspect_reader aspect
+    define_method aspect, -> {
+      fetch(aspect)
+    }
+  end
+
+  def self.aspect_accessor aspect
+    aspect_reader aspect
+    aspect_writer aspect
+  end
+end

data/lib/thyng/version.rb

@@ -0,0 +1,3 @@
+class Thyng < Hash
+  VERSION = "0.0.1"
+end

data/tasks/test.rake

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+
+test_tasks = Dir['test/*/'].map { |d| File.basename(d) }
+
+test_tasks.each do |folder|
+  Rake::TestTask.new("test:#{folder}") do |test|
+    test.pattern = "test/#{folder}/**/*_test.rb"
+    test.verbose = true
+  end
+end
+
+desc "Run application test suite"
+Rake::TestTask.new("test") do |test|
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end

data/test/core/accessor_test.rb

@@ -0,0 +1,23 @@
+require_relative '../test_config'
+
+class ReaderTest < MiniTest::Test
+  def gomez
+    'Gomez'
+  end
+
+  def accessor_example
+    @accessor_example ||= Class.new Thyng do
+      aspect_accessor :name
+    end
+  end
+
+  def test_accessor_sets_writer
+    example = accessor_example.new
+    assert example.respond_to?('name='), 'Should create writer method'
+  end
+
+  def test_responds_to_reader_method
+    example = accessor_example.new
+    assert example.respond_to?('name'), 'Should create reader method'
+  end
+end

data/test/core/initializer_test.rb

@@ -0,0 +1,18 @@
+require_relative '../test_config'
+
+class InitializerTest < MiniTest::Test
+  def gomez
+    'Gomez'
+  end
+
+  def accessor_example
+    @accessor_example ||= Class.new Thyng do
+      aspect_accessor :name
+    end
+  end
+
+  def test_sets_value_on_initialize
+    person = accessor_example.new name: gomez
+    assert_equal gomez, person.name
+  end
+end

data/test/core/reader_test.rb

@@ -0,0 +1,24 @@
+require_relative '../test_config'
+
+class ReaderTest < MiniTest::Test
+  def gomez
+    'Gomez'
+  end
+
+  def reader_example
+    @reader_example ||= Class.new Thyng do
+      aspect_reader :name
+    end
+  end
+
+  def test_can_set_aspect
+    example = reader_example.new
+    example[:name] = gomez
+    assert_equal gomez, example.name
+  end
+
+  def test_responds_to_reader_method
+    example = reader_example.new
+    assert example.respond_to?('name'), 'Thyng should report response to readers'
+  end
+end

data/test/core/writer_test.rb

@@ -0,0 +1,24 @@
+require_relative '../test_config'
+
+class WriterTest < MiniTest::Test
+  def gomez
+    'Gomez'
+  end
+
+  def writer_example
+    Class.new Thyng do
+      aspect_writer :name
+    end
+  end
+
+  def test_can_set_aspect
+    example = writer_example.new
+    example.name = gomez
+    assert_equal gomez, example[:name]
+  end
+
+  def test_responds_to_writer_method
+    example = writer_example.new
+    assert example.respond_to?('name='), 'Thyng should report response to writers'
+  end
+end

data/test/test_config.rb

@@ -0,0 +1,2 @@
+require 'thyng'
+require 'minitest/autorun'

data/test/version/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../test_config'
+
+class VersionTest < MiniTest::Test
+  def test_has_version
+    assert Thyng::VERSION
+  end
+end

data/thyng.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thyng/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thyng"
+  spec.version       = Thyng::VERSION
+  spec.authors       = ["Peter Saxton"]
+  spec.email         = ["peterhsaxton@gmail.com"]
+  spec.summary       = %q{Ruby objects with public state to encourage storage as data only collections}
+  spec.description   = %q{
+    Thyng
+    
+    Ruby objects with public state to encourage storage as data only collections.
+
+    What?
+
+    A thyng is a ruby object with the convention of saving state in key:value pairs that are public on the object rather than in private instance variables.
+
+    How?
+
+    Instead of private attributes a thyng has public aspects. Basic access to these can be declared with asect_reader, aspect_write & aspect_accessor.
+
+    Why?
+
+    Will all internal state a thyng can be reconstructed completly from its data. This allows it to be passed as JSON a json object and easily be stored in a database.
+  }
+  spec.homepage      = "https://github.com/CrowdHailer/Thyng"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.3"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: thyng
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Saxton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: "\n    Thyng\n    \n    Ruby objects with public state to encourage storage
+  as data only collections.\n\n    What?\n\n    A thyng is a ruby object with the
+  convention of saving state in key:value pairs that are public on the object rather
+  than in private instance variables.\n\n    How?\n\n    Instead of private attributes
+  a thyng has public aspects. Basic access to these can be declared with asect_reader,
+  aspect_write & aspect_accessor.\n\n    Why?\n\n    Will all internal state a thyng
+  can be reconstructed completly from its data. This allows it to be passed as JSON
+  a json object and easily be stored in a database.\n  "
+email:
+- peterhsaxton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thyng.rb
+- lib/thyng/version.rb
+- tasks/test.rake
+- test/core/accessor_test.rb
+- test/core/initializer_test.rb
+- test/core/reader_test.rb
+- test/core/writer_test.rb
+- test/test_config.rb
+- test/version/version_test.rb
+- thyng.gemspec
+homepage: https://github.com/CrowdHailer/Thyng
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby objects with public state to encourage storage as data only collections
+test_files:
+- test/core/accessor_test.rb
+- test/core/initializer_test.rb
+- test/core/reader_test.rb
+- test/core/writer_test.rb
+- test/test_config.rb
+- test/version/version_test.rb