dm-aspects 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 899d985e8ae301df81eb7cab303958878d210a5e
+  data.tar.gz: 374fcccd14e92a538f71660e0c5d9756deecb673
+SHA512:
+  metadata.gz: 7aaf0a05c8e7708562f7b17aabd17254c03f47071f4c21df14b4f19525a4dabe9b5483934ac5079e8c6e9090a4e04d688f681883ac5b2b6a2440eeafc775de23
+  data.tar.gz: 546f410612f8ca2963c102faaec179e16b4d710867710b161ebf49b38e436540fb9060199fad137c63ed809ab2b20d75cd90443819627e8f569152c6fdfed6d3

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 dm-aspects.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Marden
+
+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,137 @@
+# DataMapper::Aspects
+
+Aspect-Oriented modules to add commonly needed methods and properties to your DataMapper models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dm-aspects'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### DataMapper::Aspects::Slug
+
+Adds a `:slug` property to your model:
+
+    property :slug, String, length: 75, unique: true
+
+Adds a `find_by_slug` class method to your model.
+
+Slug generation is left up to you.
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+  include DataMapper::Aspects::Slug
+
+  property :id, Serial
+end
+
+MyModel.create(slug: 'my-slug')
+MyModel.find_by_slug('')
+# => #<Game @id=1 @slug="my-slug">
+````
+
+---
+
+### DataMapper::Aspects::Status
+
+Adds a `:status` property to your model that validates it was set to one of the followig options: `'draft'`, `'published'`, `'archived'`. The default value is `'draft'`. 
+
+You can customize this by overwriting the `statuses` class method on your Model and have it return an array of strings. Just make sure the default status is first element in the array and that none of your statuses are over 50 characters long.
+
+We use this module to give admin's simple controls over the visibility of content-oriented objects. This module has helped us avoid conflating domain concerns (validation, state management, content lifecycle, etc) by implementing a state machine on models too early in the development of new applications.
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+  include DataMapper::Aspects::Status
+
+  property :id, Serial
+end
+
+MyModel.all(status: 'published')
+# => [#<MyModel @id=1 @status='published'>, #<MyModel @id=2 @status='published'>, ...]
+````
+
+Customized `statuses` example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+  include DataMapper::Aspects::Status
+
+  property :id, Serial
+
+  def self.statuses
+    %w(queued processing processed).freeze
+  end
+end
+````
+
+---
+
+### DataMapper::Aspects::Utils
+
+A collection of helper methods to make all your models a little more awesome.
+
+Class Methods:
+
+- `default_sequence_name` - Returns a string for the sequence name for your model's `Serial` property. PostgreSQL only. 
+- `next_id` - Returns the next unused value in your model's `Serial` property sequence. Use this when you need to generate an ID for your model before you've saved the object to the database. Pass it the name of your sequence if it differs from the `default_sequence_name`. PostgreSQL only.
+- `select_options` - Returns an array of hashes containing `:label` and `value` keys. Useful for building a `<select>` form input containing a list of all your objedts. Your model must have a property or method called `name`, which is set as the `label`.  The `:value` will be set to your model's `Serial` property (determined automatically) and can be named anything you like.
+
+Instance Methods:
+
+- `changed?` - Pass it the name of one of your model's properties and it will return a `Boolean` indicating whether or not the field has been changed since you queried it from the database. Use this to avoid performing some expensive operation (like generating a slug, or uploading an image) if the field hasn't changed. Relies on DataMapper's built-in dirty attributes tracking.
+- `attributes_json` - Uses the super-fast `oj` gem  to serialize and return a json string of all of your model's attributes.
+
+Example:
+
+````ruby
+class Thing
+  include DataMapper::Resource
+  include DataMapper::Aspects::Utils
+
+  property :id, Serial
+  property :name, String
+end
+
+
+Thing.default_sequence_name
+# => "things_id_seq"
+
+Thing.next_id
+# => 2
+
+Thing.select_options
+# => [{:label => 'Thing 1', :value => 1},{:label => 'Thing 2', :value => 1}]
+
+thing = Thing.first
+thing.name = 'Thing-a-ma-jig'
+thing.changed?(:name)
+# => true
+thing.save # once your object is persisted, dirty tracking is reset
+thing.changed?(:name)
+# => false
+
+Thing.first.attributes_json
+# => '{"id":1,"name":"Thing 1"}'
+````
+
+## Contributing
+
+1. Fork it ( http://github.com/styleseek/dm-aspects/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 new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+# environment
+ENV['RACK_ENV'] ||= 'development'
+
+# load path
+lib_path = File.expand_path('../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+task :default => [:test]

data/dm-aspects.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datamapper/aspects/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dm-aspects"
+  gem.version       = DataMapper::Aspects::VERSION
+  gem.authors       = ['StyleSeek Engineering Team']
+  gem.email         = ['engineering@styleseek.com']
+  gem.summary       = %q{Aspect-Oriented modules to add enhance your DataMapper models.}
+  gem.description   = %q{Aspect-Oriented modules to add commonly needed methods and properties to your DataMapper models.}
+  gem.homepage      = "https://github.com/styleseek/dm-aspects"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'dm-core'
+  gem.add_dependency 'oj'
+  
+  gem.add_development_dependency "bundler", "~> 1.5"
+  gem.add_development_dependency "rake"
+end

data/lib/datamapper/aspects/slug.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module DataMapper
+  module Aspects
+    module Slug
+      def self.included(base)
+        base.property :slug, String, length: 75, unique: true
+        def base.find_by_slug(slug)
+          first(slug: slug, order: [:updated_at.desc])
+        end
+      end
+    end
+  end
+end

data/lib/datamapper/aspects/status.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module DataMapper
+  module Aspects
+    module Status
+
+      def self.statuses
+        %w(draft published archived).freeze
+      end
+
+      def self.included(base)
+        base.property :status, String, default: ->(r,p) { self.statuses.first }
+        base.validates_within :status, set: self.statuses
+      end
+    end
+  end
+end

data/lib/datamapper/aspects/utils.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module DataMapper
+  module Aspects
+    module Utils
+      def self.included(base)
+        def base.default_sequence_name
+          "#{DataMapper::Inflector.pluralize(self.to_s)}_#{self.serial.name}_seq"
+        end
+
+        def base.next_id(sequence = default_sequence_name)
+          repository.adapter.select("select nextval('#{sequence}')").first
+        end
+
+        def base.select_options
+          all(order: [:updated_at.desc]).map do |object|
+            { label: object.name, value: object.send(self.serial.name) }
+          end
+        end
+      end
+
+      def changed?(property)
+        dirty_attribute_names.include?(property)
+      end
+
+      def attributes_json
+        @attributes_json ||= Oj.dump(self.attributes, mode: :compat)
+      end
+
+      private
+
+      def dirty_attribute_names
+        dirty_attributes.keys.map { |p| p.name }
+      end
+    end
+  end
+end

data/lib/datamapper/aspects/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Aspects
+    VERSION = "0.0.1"
+  end
+end

data/lib/datamapper/aspects.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'aspects/slug'
+require 'aspects/status'
+require 'aspects/utils'
+require 'aspects/version'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dm-aspects
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- StyleSeek Engineering Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Aspect-Oriented modules to add commonly needed methods and properties
+  to your DataMapper models.
+email:
+- engineering@styleseek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-aspects.gemspec
+- lib/datamapper/aspects.rb
+- lib/datamapper/aspects/slug.rb
+- lib/datamapper/aspects/status.rb
+- lib/datamapper/aspects/utils.rb
+- lib/datamapper/aspects/version.rb
+homepage: https://github.com/styleseek/dm-aspects
+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.0
+signing_key: 
+specification_version: 4
+summary: Aspect-Oriented modules to add enhance your DataMapper models.
+test_files: []