scope_composer 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTRkOTIwMzFmZWNjN2NjNTFkYzUwNzNkMDUyMDcxOGM5YzdhNmFjZQ==
+  data.tar.gz: !binary |-
+    OTU4NzQwZjJhZmYyM2JmNmJlMWJhYjlmMDgwMjBiMjNjODU1ODg5MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODU1YWQwMGI5YWFiODRmMTkwMWJjZjM0MWRjYWNlZmVhYjkwMmQ5YThiM2M3
+    ZWU1ZjQxYzI5MjkwMDIxYzk4NWQ5MzM2YWE5MDU3MDk0MzNlZWExZTQ1MGEz
+    MTExNjgwODZjNDIyM2NhZWFhZTUxZWIwNzUxYjEwZjI1MTg5NWU=
+  data.tar.gz: !binary |-
+    ODUwZmViZjkzNmM4NmFiZDEyZjZhOTY1NTJlNmEyYTIxNWJmN2UxYjliNjg0
+    YWU1NjUyYWQxYjAxMWU3MTdhMGFjZjIyMTBlNmUwZDgzMTlkZmRkNjI3MmZh
+    NmQ0YWZhNTkwYjczODg1NGIwZDViZTVkYzQ1OTBhMThiZTRhZWU=

data/.gitignore

@@ -0,0 +1,4 @@
+/Gemfile.lock
+/pkg
+/tmp
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format=Fivemat

data/.rvmrc

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p392@scope_builder"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.19.6 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+
+gemfile:
+  - Gemfile
+  - gemfiles/activemodel-4.0.gemfile
+
+matrix:
+  exclude:
+  - rvm: 1.8.7
+    gemfile: gemfiles/activemodel-4.0.gemfile
+  - rvm: 1.9.2
+    gemfile: gemfiles/activemodel-4.0.gemfile
+
+script: "echo 'COME ON!' && bundle exec rake spec"

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--no-private

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012-2013 Blake Hilscher
+
+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,42 @@
+# ScopeComposer
+
+```ruby
+class Example
+
+  include ScopeComposer::Model
+
+  scope_composer_for :search
+
+  search_helper :integer, ->(v){ v.to_s.to_i }
+
+  search_scope :limit
+  search_scope :offset, ->(i){ where(offset: integer(i) ) }
+
+  search_helper :find, ->(id){ Example.where(self.attributes).find(id) }
+
+  def self.where(attrs)
+    puts "where: #{attrs.to_param}"
+    self
+  end
+
+  def self.find(id)
+    puts "find by #{id}"
+    self.new
+  end
+
+end
+
+Example.limit(10).offset('50').find(10)
+Example.limit(10).offset('50').to_param
+
+scope = Example.limit(10)
+scope.offset(20)
+scope.find(2)
+
+```
+
+```
+where: limit=10&offset=50
+find by 10
+Example:0x007ff8eb8ce920
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rake"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "spec/**/*_spec.rb"
+end

data/UPGRADE.md

@@ -0,0 +1,3 @@
+## 0.1
+
+Initial

data/lib/scope_composer/model.rb

@@ -0,0 +1,25 @@
+module ScopeComposer
+  module Model
+  
+    extend ActiveSupport::Concern
+  
+    module ClassMethods
+      
+      def has_scope_composer
+        ScopeComposer::Scope.define_scope_composer( self, :scope )
+        # alias_method scope and scope_helper
+        self.define_singleton_method(:scope){|*args| scope_scope(*args) }
+      end
+      
+      def scope_composer_for(*args)
+        # each scope_composer arg is a new type of scope
+        args.each do |scope_type|
+          # define a class method for adding scopes to the composer
+          ScopeComposer::Scope.define_scope_composer( self, scope_type )
+        end
+      end
+     
+    end
+  
+  end
+end

data/lib/scope_composer/scope.rb

@@ -0,0 +1,164 @@
+module ScopeComposer
+class Scope
+  
+  class << self
+    
+    def define_scope_composer( parent_class, scope_type )
+      # define a class method for adding scopes to the composer
+      scope_subclass = define_scope_subclass( parent_class, scope_type  )
+      # eg. dataset_scope :limit
+      parent_class.send(:define_singleton_method, "#{scope_type}_scope") do |*args|
+        # act as getter if args are nil
+        return scope_subclass if args.first.nil?
+        # delegate the scope definition to the sub-class
+        scope_subclass.define_scope(*args)
+        scope_subclass.define_scope_delegate(parent_class, scope_type, *args)
+      end
+      parent_class.send(:define_singleton_method, "#{scope_type}_helper") do |*args|
+        scope_subclass.define_helper(*args)
+      end
+    end
+    
+    def define_scope(*args)
+      args[1].is_a?(Proc) ? define_proc_scope(*args) : define_simple_scopes(*args)
+    end
+    
+    def define_helper(name, proc, *args)
+      # ensure symbol
+      name = name.to_sym
+      # define method
+      define_method(name) do |*args|
+        # otherwise set the value
+        instance_exec(*args, &proc)
+      end
+      # add to scope list
+      helpers[name] = proc
+    end
+    
+    def define_scope_delegate(parent_class, scope_type, *args)
+      # options
+      options = args.extract_options!
+      scope_subclass = self
+      # for each scope name
+      args.each do |scope_name|
+        # skip non text scopes
+        next unless scope_name.is_a?(String) || scope_name.is_a?(Symbol)
+        # add prefix if required
+        method_name = scope_name
+        method_name = "#{method_name}_#{scope_type}" if options[:prefix] == true
+        # define method
+        parent_class.send(:define_singleton_method, method_name) do |*args|
+          # delegate the scope to an instance of this scope
+          scope_subclass.new.send( scope_name, *args )
+        end
+      end
+    end
+    
+    def scope_names
+      @scope_names ||= scopes.keys
+    end
+    
+    def helper_names
+      @helper_names ||= helpers.keys
+    end
+    
+    def scopes
+      @scopes ||= {}
+    end
+    
+    def helpers
+      @helpers ||= {}
+    end
+    
+    protected
+    
+    def define_scope_subclass(parent_class, scope_type)
+      # the class name
+      class_name = "#{scope_type.to_s.camelize}Scope"
+      # define the class if it doesn't exist
+      unless parent_class.const_defined?(class_name)
+        # the new scope class inherits from Scope
+        scope_class = Class.new(ScopeComposer::Scope)
+        # the class is attached the parent class
+        parent_class.const_set class_name, scope_class
+      end
+      # return the scope class
+      "#{parent_class.name}::#{class_name}".constantize
+    end
+    
+    def define_proc_scope(name, proc, *args)
+      # ensure symbol
+      name = name.to_sym
+      # define method
+      define_method(name) do |*args|
+        # if no value is given, act as a getter and retrieve the value
+        return attributes[name] if args.first.nil?
+        # otherwise set the value
+        instance_exec(*args, &proc)
+        # and return self for chaining
+        self
+      end
+      define_method("#{name}=") do |value|
+        self.send( name, value )
+      end
+      # add to scope list
+      scopes[name] = proc
+    end
+    
+    def define_simple_scopes(*args)
+      options = args.extract_options!
+      args.each { |name| define_simple_scope(name, options) }
+    end
+    
+    def define_simple_scope(name, options)
+      # ensure symbol
+      name = name.to_sym
+      # define method
+      define_method(name) do |*args|
+        # init
+        value = args.first
+        # if no value is given, act as a getter
+        return attributes[name] if value.nil?
+        # otherwise set the value
+        where( name => value )
+        # and return self for chaining
+        return self
+      end
+      define_method("#{name}=") do |*args|
+        self.send( name, *args )
+      end
+      # add to scoping list
+      scopes[name] = nil
+    end
+  
+  end
+  
+  delegate :to_param, to: :attributes
+  
+  def assign_attributes(*attrs)
+    attrs = attrs.extract_options!
+    attrs.each do |key, value|
+      self.send("#{key}=", value) if self.respond_to?("#{key}=")
+    end
+  end
+  
+  def attributes
+    self.class.scopes.keys.inject({}){|m,k| m.merge( k => attributes[k] ) }
+  end
+  
+  def where(*args)
+    attrs = args.extract_options!
+    attrs.symbolize_keys!
+    self.attributes = attrs
+  end
+
+  def attributes
+    @attributes ||= {}
+  end
+
+  def attributes=(attrs)
+    @attributes = self.attributes.merge(attrs)
+  end
+  
+end
+end

data/lib/scope_composer/version.rb

@@ -0,0 +1,3 @@
+module ScopeComposer
+  VERSION = "0.0.1"
+end

data/lib/scope_composer.rb

@@ -0,0 +1,12 @@
+require "scope_composer/version"
+
+require "active_support"
+require "active_support/inflector"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/object"
+
+require "scope_composer/scope"
+require "scope_composer/model"
+
+module ScopeComposer
+end

data/scope_composer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scope_composer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scope_composer"
+  s.version     = ScopeComposer::VERSION
+  s.authors     = ["Blake Hilscher"]
+  s.email       = ["blake@hilscher.ca"]
+  s.homepage    = "http://blake.hilscher.ca/"
+  s.license     = "MIT"
+  s.summary     = "For building scopes"
+  s.description = "Scopes will be built"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 2.13"
+  s.add_development_dependency "fivemat", "~> 1.2"
+  s.add_development_dependency "pry"
+
+  s.add_runtime_dependency "activesupport", ">= 3.0.0"
+end

data/spec/scope_composer/model_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ScopeComposer::Model do
+  subject do
+    class TestClass
+      include ScopeComposer::Model
+      
+      has_scope_composer
+      scope :say_hi, ->(t){ 'hi' }
+      scope_helper :helper_method, ->(t){ 'hi' }
+      
+      scope_composer_for :search
+      
+      search_scope :limit
+      search_scope :offset, prefix: true
+      search_helper :tester, ->(t){ t.to_i }
+      
+    end
+    TestClass
+  end
+  
+  it { should respond_to :scope_composer_for }
+  it { should respond_to :scope_scope }
+  it { should respond_to :scope }
+  it { should respond_to :say_hi }
+  
+  it { should respond_to :search_scope }
+  it { should respond_to :search_helper }
+  it { should respond_to :limit }
+  it { should respond_to :offset_search }
+  it { should_not respond_to :tester }
+
+  it "should define a scope helper" do
+    TestClass.say_hi('hi').should respond_to :helper_method
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+require "scope_composer"

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: scope_composer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Blake Hilscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  name: fivemat
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Scopes will be built
+email:
+- blake@hilscher.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- UPGRADE.md
+- lib/scope_composer.rb
+- lib/scope_composer/model.rb
+- lib/scope_composer/scope.rb
+- lib/scope_composer/version.rb
+- scope_composer.gemspec
+- spec/scope_composer/model_spec.rb
+- spec/spec_helper.rb
+homepage: http://blake.hilscher.ca/
+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.5
+signing_key: 
+specification_version: 4
+summary: For building scopes
+test_files:
+- spec/scope_composer/model_spec.rb
+- spec/spec_helper.rb