pebbles-path 0.0.1

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 pebbles-path.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Katrina Owen
+
+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,68 @@
+# PebblePath
+
+Provides searchable, parseable pebbles-compliant UID paths, e.g. (such as `a.b.*`) for Active Record models.
+
+## Requirements
+
+Requires ActiveModel. The target class (the one that will contain the `path` property) needs to have fields in the DB for:
+
+```
+label_0
+label_1
+label_2
+label_3
+label_4
+label_5
+label_6
+label_7
+label_8
+label_9
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pebble_path'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pebble_path
+
+Create a migration for the table that you want to put the paths on, e.g.
+
+    def self.up
+      labels = (0..9).map { |i| "label_#{i}".to_sym }
+
+      create_table :locations do |t|
+        labels.each do |label|
+          t.text label
+        end
+        t.timestamps
+      end
+
+      add_index :locations, labels, :unique => true, :name => 'index_locations_on_labels'
+    end
+
+
+## Usage
+
+Include the `PebblePath` module in the `ActiveRecord` model that has the labels
+
+```
+class Location < ActiveRecord::Base
+  include PebblePath
+end
+```
+
+## 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/lib/pebbles-path.rb

@@ -0,0 +1,61 @@
+require "pebbles-path/version"
+
+module Pebbles
+  module Path
+
+    def self.max_depth
+      Positions::MAX_DEPTH
+    end
+
+    def self.to_conditions(paths)
+      Positions.to_conditions(paths)
+    end
+
+    def self.included(base)
+      base.class_eval do
+        scope :by_path, lambda { |path|
+          where Positions.to_conditions(path)
+        }
+
+        validates_presence_of :label_0
+        validate :must_be_valid_uid_path
+
+        after_initialize :initialize_path
+
+        def self.declare!(path)
+          raise ArgumentError, "Path must be valid" unless Pebbles::Uid.valid_path?(path)
+          attributes = PebblePath.to_conditions(path)
+          path = self.where(attributes).first
+          path ||= self.create!(attributes)
+        end
+
+      end
+    end
+
+    attr_reader :path
+    def path=(positions)
+      @path = Positions.new(positions)
+
+      path.all.each_with_index do |value, i|
+        send(:"label_#{i}=", value)
+      end
+      path
+    end
+
+    def initialize_path
+      positions = []
+      [:label_0, :label_1, :label_2, :label_3, :label_4, :label_5, :label_6, :label_7, :label_8, :label_9].each do |attribute|
+        positions << send(attribute)
+      end
+      self.path = positions
+    end
+
+    def must_be_valid_uid_path
+      unless Pebbles::Uid.valid_path?(self.path.to_s)
+        errors.add(:base, "Location path '#{self.path.to_s}' is invalid.")
+      end
+    end
+
+  end
+end
+

data/lib/pebbles-path/positions.rb

@@ -0,0 +1,61 @@
+require 'pebbles-uid'
+
+module Pebbles::Path
+  class Positions
+    include Enumerable
+
+    MAX_DEPTH = 10
+
+    attr_reader :labels, :all
+    def initialize(positions)
+      @all = resolve positions
+      @labels = all.compact
+    end
+
+    def each
+      labels.each {|label| yield label}
+    end
+
+    def [](index)
+      labels[index]
+    end
+
+    def []=(index, value)
+      labels[index] = value
+    end
+
+    def to_s
+      labels.join('.')
+    end
+
+    def resolve(positions)
+      positions = positions.split('.') if positions.is_a?(String)
+      positions = truncate_invalid(positions)
+      (0...MAX_DEPTH).map do |i|
+        positions[i]
+      end
+    end
+
+    def truncate_invalid(positions)
+      labels = []
+      (0...MAX_DEPTH).each do |i|
+        break if positions[i].nil?
+        labels << positions[i]
+      end
+      labels
+    end
+
+    class << self
+
+      def to_conditions(path)
+        unless Pebbles::Uid::Wildcard.valid?(path)
+          raise ArgumentError.new("Wildcards terminate the path. Invalid path: #{path}")
+        end
+
+        labels = Pebbles::Uid::Labels.new(path, :name => 'label', :max_depth => MAX_DEPTH, :stop => nil)
+        labels.to_hash
+      end
+    end
+  end
+
+end

data/lib/pebbles-path/version.rb

@@ -0,0 +1,5 @@
+module Pebbles
+  module Path
+    VERSION = "0.0.1"
+  end
+end

data/lib/pebbles/path.rb

@@ -0,0 +1 @@
+require 'pebbles-path'

data/pebbles-path.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pebbles-path/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pebbles-path"
+  gem.version       = Pebbles::Path::VERSION
+  gem.authors       = ["Katrina Owen"]
+  gem.email         = ["katrina.owen@gmail.com"]
+  gem.description   = %q{Provide pebble-compliant paths for ActiveRecord models.}
+  gem.summary       = %q{Provides searchable, parseable pebble-compliant UID paths, e.g. (such as a.b.*) for Active Record models.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'pebbles-uid', '>=0.0.6'
+end

data/spec/path_spec.rb

@@ -0,0 +1,98 @@
+require 'pebbles-path'
+
+class Thing
+  def self.scope(*attrs)
+  end
+  def self.after_initialize(*attrs)
+  end
+  def self.validates_presence_of(*attrs)
+  end
+  def self.validate(*attrs)
+  end
+
+  (0..9).each do |i|
+    attr_accessor "label_#{i}".to_sym
+  end
+
+  include Pebbles::Path
+end
+
+describe Pebbles::Path do
+  subject do
+    thing = Thing.new
+    thing.path = "a.b.c.d.e"
+    thing
+  end
+
+  describe "path" do
+
+    it "accepts an array" do
+      subject.path = %w(a b c)
+      "#{subject.path}".should eq("a.b.c")
+    end
+
+    it "accepts a string" do
+      subject.path = "a.b.c"
+      "#{subject.path}".should eq("a.b.c")
+    end
+
+    it "doesn't do weird stuff" do
+      subject.path = [nil, 'a']
+      "#{subject.path}".should eq("")
+    end
+
+    specify { subject.path.map{|label| label + label}.should eq %w(aa bb cc dd ee) }
+
+    specify { subject.path[1].should eq('b') }
+
+    specify do
+      subject.path[2] = 'x'
+      "#{subject.path}".should eq("a.b.x.d.e")
+    end
+
+    its(:label_0) { should eq('a') }
+    its(:label_1) { should eq('b') }
+    its(:label_2) { should eq('c') }
+    its(:label_3) { should eq('d') }
+    its(:label_4) { should eq('e') }
+
+    [:label_5, :label_6, :label_7, :label_8, :label_9].each do |attribute|
+      it "hasn't filled #{attribute}" do
+        subject.send(attribute).should be_nil
+      end
+    end
+  end
+
+  describe "overwrites labels" do
+    before(:each) do
+      subject.path = 'a.b.c'
+    end
+
+    its(:label_0) { should eq('a') }
+    its(:label_1) { should eq('b') }
+    its(:label_2) { should eq('c') }
+
+    [:label_3, :label_4, :label_5, :label_6, :label_7, :label_8, :label_9].each do |attribute|
+      it "overwrites #{attribute}" do
+        subject.send(attribute).should be_nil
+      end
+    end
+  end
+
+  it "initializes path from label" do
+    subject.path = []
+    subject.label_0 = 'a'
+    subject.label_1 = 'b'
+    subject.label_2 = 'c'
+    subject.path.to_s.should eq('')
+    subject.initialize_path
+    subject.path.to_s.should eq('a.b.c')
+  end
+
+  describe "no stray labels" do
+    it "stops setting labels when it reaches a nil" do
+      subject.path = ['a', 'b', nil, 'd']
+      subject.path.to_s.should eq('a.b')
+    end
+  end
+end

data/spec/positions_spec.rb

@@ -0,0 +1,45 @@
+require 'pebbles-path/positions'
+
+describe Pebbles::Path::Positions do
+  subject { Pebbles::Path::Positions }
+
+  let(:full_path) do
+    {
+      :label_0 => "a",
+      :label_1 => "b",
+      :label_2 => "c",
+      :label_3 => "d",
+      :label_4 => "e",
+      :label_5 => "f",
+      :label_6 => "g",
+      :label_7 => "h",
+      :label_8 => "i",
+      :label_9 => "j",
+    }
+  end
+
+  describe "#to_conditions" do
+
+    specify do
+      subject.to_conditions("a.b.c.d.e.f.g.h.i.j").should eq(full_path)
+    end
+
+    specify do
+      subject.to_conditions("a.b.c").should eq({:label_0=>"a", :label_1=>"b", :label_2=>"c", :label_3=>nil})
+    end
+
+    specify do
+      subject.to_conditions("a.b.*").should eq({:label_0=>"a", :label_1=>"b"})
+    end
+
+    specify do
+      subject.to_conditions("a.^b.c").should eq({:label_0=>"a", :label_1=>["b", nil], :label_2=>["c", nil], :label_3=>nil})
+    end
+
+    specify do
+      subject.to_conditions("a.b|c.d").should eq({:label_0=>"a", :label_1=>["b", "c"], :label_2=>"d", :label_3=>nil})
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: pebbles-path
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70095621197620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095621197620
+- !ruby/object:Gem::Dependency
+  name: pebbles-uid
+  requirement: &70095621196600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095621196600
+description: Provide pebble-compliant paths for ActiveRecord models.
+email:
+- katrina.owen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pebbles-path.rb
+- lib/pebbles-path/positions.rb
+- lib/pebbles-path/version.rb
+- lib/pebbles/path.rb
+- pebbles-path.gemspec
+- spec/path_spec.rb
+- spec/positions_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Provides searchable, parseable pebble-compliant UID paths, e.g. (such as
+  a.b.*) for Active Record models.
+test_files:
+- spec/path_spec.rb
+- spec/positions_spec.rb