active_model-shaz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d075ae77ef66ee24bca0bc1b2361db155772147c
+  data.tar.gz: 7e73898484615cc08554cf2bf281b67b65f5a716
+SHA512:
+  metadata.gz: 15d9fa3c796309ebec24b48514106fba03f0f676a8225fa85033fa86e726252efbd3f0608159b7953fb488943f4210b21034be514a5a65b7900711fc5e72173d
+  data.tar.gz: b6a77edf52499f2f2ff4d8fbfa43fa7b59655d3de29a5923a51dc717961290db177035e53f9c91d186e9a502dc05879007fdac2da3aae7251faeb743c17da9ed

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kristian Mandrup
+
+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,56 @@
+# ActiveModel::Shaz
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_model-shaz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model-shaz
+
+## Support
+
+Currently auto-configures for Mongoid and ActiveRecord. Easy to configure for your particular "ORM",
+
+## Usage
+
+Mostly useful in REST API scenarios, where you want to transfer the model state to the client efficiently
+
+```ruby
+model.created?
+model.deleted?
+
+model.saved # save and return saved model
+model.updated_with(name: 'hello') # update and return updated model
+model.destroyed # destroy and return destroyed model
+```
+
+Controller usage example
+
+```ruby
+MyController < APIController
+  def update
+    render json: user.updated_with name: 'hello'
+  end
+
+  def destroy
+    render json: user.destroyed
+  end
+end
+```
+
+When used with state tracking, this will add the `http_status` method so you can send the http status code, `201` or `204` auto-magically to your client in your JSON response via `ActiveModel::Serializer`. See f.ex [mongoid-serializer](https://github.com/kristianmandrup/mongoid-serializer) gem.
+
+## 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 @@
+require "bundler/gem_tasks"

data/active_model-shaz.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/shaz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-shaz"
+  spec.version       = ActiveModel::Shaz::VERSION
+  spec.authors       = ["Kristian Mandrup"]
+  spec.email         = ["kmandrup@gmail.com"]
+  spec.description   = %q{Adds state tracking and a few extra snappy save and destroy methods to your model API}
+  spec.summary       = %q{Shaz up your ActiveModel with state tracking and more}
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/active_model/shaz.rb

@@ -0,0 +1,41 @@
+require "active_model/shaz/version"
+require "active_model/state_tracking"
+
+module ActiveModel
+  module Shaz
+    def save_it
+      self.save
+      self
+    end
+    alias_method :saved, :save_it
+
+    def update_it *args
+      self.update *args
+      self
+    end
+    alias_method :updated_with, :update_it
+
+    def destroy_it
+      self.destroy
+      self
+    end
+    alias_method :destroyed, :destroy_it
+
+    def self.configure_for clazz
+      [:state_tracking, :shaz].each do |name|
+        clazz.send :include, "ActiveModel::#{name.to_s.camelize}".constantize
+      end
+    end
+  end
+end
+
+
+if defined? Mongoid
+  ActiveMode::Shaz.configure_for Mongoid::Document
+end
+
+if defined?(ActiveRecord) && defined?(ActiveRecord::Base) 
+  ActiveMode::Shaz.configure_for ActiveRecord::Base
+end
+
+

data/lib/active_model/shaz/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module Shaz
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_model/state_tracking.rb

@@ -0,0 +1,25 @@
+module ActiveModel::StateTracking
+  extend ActiveSupport::Concern
+
+  included do
+    after_create do
+      @created = true
+    end
+
+    after_update do
+      @created = false
+    end
+
+    after_destroy do
+      @destroyed = true
+    end
+  end
+
+  def created?
+    @created == true
+  end
+
+  def destroyed?
+    @destroyed == true
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: active_model-shaz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds state tracking and a few extra snappy save and destroy methods to
+  your model API
+email:
+- kmandrup@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model-shaz.gemspec
+- lib/active_model/shaz.rb
+- lib/active_model/shaz/version.rb
+- lib/active_model/state_tracking.rb
+homepage: ''
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Shaz up your ActiveModel with state tracking and more
+test_files: []
+has_rdoc: