chassis_repo 0.1.0

data/.gitignore

@@ -0,0 +1,47 @@
+# Vagrant #
+###################
+.vagrant
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+nsqd.*.dat
+
+# Rubygems #
+############
+pkg

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    chassis (0.1.0)
+      interchange
+      lift
+      logger-better
+      prox
+      tnt
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    builder (3.2.2)
+    interchange (0.1.0)
+    lift (0.1.0)
+    logger-better (0.2.1)
+    metaclass (0.0.4)
+    minitest (5.4.2)
+    minitest-reporters (1.0.7)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    prox (0.0.1)
+    rake (10.4.2)
+    ruby-progressbar (1.7.0)
+    tnt (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  chassis!
+  minitest (= 5.4.2)
+  minitest-reporters
+  mocha
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+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,118 @@
+# ChassisRepo
+
+ChassisRepo is the repo part of the [Chassis project](https://github.com/ahawkins/chassis) which will be used for MagLev.
+
+## Support Libraries
+
+Chassis is implemented with help from a few smaller libraries. A
+unified interface if you do not want to know about such things.
+
+* Errors with [TNT](https://github.com/ahawkins/tnt)
+* Object initialization with [Lift](https://github.com/ahawkins/lift)
+* Interchangeable objects with [Interchange](https://github.com/ahawkins/interchange)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chassis_repo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chassis_repo
+
+
+## Data Access
+
+Chassis includes a
+[repository](http://martinfowler.com/eaaCatalog/repository.html) using
+the query pattern as well. The repository pattern is perfect because
+it does not require knowledge about your persistence layer. It is the
+access layer. A null, in-memory, and Redis adapter are included. You
+can subclass these adapters to make your own.
+`Chassis::Repo::Delegation` can be included in other classes to
+delegate to the repository.
+
+Here's an example:
+
+```ruby
+class CustomerRepo
+  extend Chassis::Repo::Delegation
+end
+```
+
+Now there are CRUD methods available on `CustomerRepo` that delegate
+to the repository for `Customer` objects. `Chassis::Persistence` can
+be included in any object. It will make the object compatible with
+the matching repo.
+
+```ruby
+class Customer
+  include Chassis::Persistence
+end
+```
+
+Now `Customer` responds to `id`, `save`, and `repo`. `repo` looks for
+a repository class matching the class name (e.g. `CustomerRepo`).
+Override as you see if.
+
+More on my blog
+[here](http://hawkins.io/2014/01/pesistence_with_repository_and_query_patterns/).
+
+
+## Chassis::DirtySession
+
+A proxy object used to track assignments. Wrap an object in a dirty
+session to see what changed and what it changed to.
+
+```ruby
+Person = Struct.new :name
+
+adam = Person.new 'adam'
+
+session = Chassis::DirtySession.new adam
+session.clean? # => true
+session.dirty? # => false
+
+session.name = 'Adman'
+
+session.dirty? # => true
+session.clean? # => false
+
+session.named_changed? # => true
+session.changed # => set of values changed
+session.new_values # => { name: 'Adman' }
+session.original_values # => { name: 'adam' }
+
+session.reset! # reset everything back to normal
+```
+
+## Chassis::Logger
+
+Chassis includes the `logger-better` gem to refine the standard
+library logger. `Chassis::Logger` default the `logdev` argument to
+`Chassis.stream`. This gives a unified place to assign all output.
+The log level can also be controlled by the `LOG_LEVEL` environment
+variable. This makes it possible to restart/boot the application with
+a new log level without redeploying code.
+
+## Chassis::Observable
+
+A very simple implementation of the observer pattern. It is different
+from the standard library implementation for two reasons:
+
+* you don't need to call `changed` for `notify_observers` to work.
+* `notify_obsevers` includes `self` as first argument to all observers
+* there is only the `add_observer` method.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require "rubygems"
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+require "stringio"
+
+def capture_stdout
+  out = StringIO.new
+  $stdout = out
+  yield
+  return out
+ensure
+  $stdout = STDOUT
+end
+
+desc "Run examples"
+task :examples do
+  root = File.dirname __FILE__
+  Dir["#{root}/examples/*.rb"].each do |example|
+    capture_stdout do
+      require example
+    end
+  end
+end
+
+namespace :test do
+  Rake::TestTask.new(:all) do |t|
+    t.test_files = FileList['test/**/*_test.rb']
+  end
+end
+
+task test: ["test:all", "examples"]
+
+task default: :test

data/chassis_repo.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chassis/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chassis_repo"
+  spec.version       = Chassis::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{A collection of modules and helpers for building mantainable Ruby applications}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "interchange"
+  spec.add_dependency "tnt"
+  spec.add_dependency "lift"
+
+  spec.add_dependency "prox"
+  spec.add_dependency "logger-better"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "minitest", "= 5.4.2"
+  spec.add_development_dependency "minitest-reporters"
+end

data/examples/maglev_repo.rb

@@ -0,0 +1,56 @@
+require_relative '../lib/chassis'
+
+Maglev.abort
+
+ROOT_KEY = :chassis_example
+Maglev[ROOT_KEY] = {}
+Maglev.commit
+
+Chassis.repo.register :maglev, Chassis::MaglevRepo.new(Maglev[ROOT_KEY])
+Chassis.repo.use :maglev
+
+class Post
+  attr_accessor :id, :title, :text
+end
+Post.maglev_persistable
+
+repo = Chassis.repo
+
+puts repo.empty? Post #=> true
+
+post = Post.new
+post.title = 'Such Repos'
+post.text = 'Very wow. Much design.'
+
+repo.save post
+
+puts post.id #=> 1
+
+found_post = repo.find Post, post.id
+found_post == post #=> true (no difference between objects in memory)
+
+post.title = 'Such updates'
+post.text = 'Very easy. Wow'
+
+repo.save post
+
+repo.find(Post, post.id).text #=> 'Very easy. Wow.'
+
+class PostRepo
+  extend Chassis::Repo::Delegation
+end
+
+post = Post.new
+post.title = 'Such Repos'
+post.text = 'Very wow. Much design.'
+
+PostRepo.save post
+
+post = PostRepo.find post.id
+post.text #=> 'Very Easy. Wow'
+
+PostRepo.all #=> [post]
+# etc
+
+PostRepo.delete post
+PostRepo.empty? #=> true

data/examples/repo.rb

@@ -0,0 +1,40 @@
+require 'chassis'
+
+class Post
+  attr_accessor :id, :title, :text
+end
+
+repo = Chassis::Repo.default
+
+puts repo.empty? Post #=> true
+
+post = Post.new
+post.title = 'Such Repos'
+post.text = 'Very wow. Much design.'
+
+repo.save post
+
+puts post.id #=> 1
+
+found_post = repo.find Post, post.id
+found_post == post #=> true (no difference between objects in memory)
+
+post.title = 'Such updates'
+post.text = 'Very easy. Wow'
+
+repo.save post
+
+repo.find(Post, post.id).text #=> 'Very easy. Wow.'
+
+class PostRepo
+  extend Chassis::Repo::Delegation
+end
+
+post = PostRepo.find post.id
+post.text #=> 'Very Easy. Wow'
+
+PostRepo.all #=> [post]
+# etc
+
+PostRepo.delete post
+PostRepo.empty? #=> true

data/lib/chassis.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+
+require 'interchange'
+require 'tnt'
+require 'lift'
+require 'logger-better'
+require 'prox'
+
+module Chassis
+  Proxy = Prox
+  class << self
+    def stream
+      @stream
+    end
+
+    def stream=(stream)
+      @stream = stream
+    end
+  end
+end
+
+require_relative 'chassis/hash_utils'
+require_relative 'chassis/string_utils'
+require_relative 'chassis/array_utils'
+require_relative 'chassis/error'
+require_relative 'chassis/logger'
+require_relative 'chassis/persistence'
+require_relative 'chassis/initializable'
+require_relative 'chassis/repo'
+require_relative 'chassis/delegate'
+
+Chassis.repo.register :memory, Chassis::MemoryRepo.new
+Chassis.repo.register :null, Chassis::NullRepo.new
+Chassis.repo.use :memory