jeremyboles-dm-is-sluggable 0.9.8

data/History.txt

@@ -0,0 +1 @@
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 John Doe
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+LICENSE
+Manifest.txt
+README.markdown
+Rakefile
+TODO
+lib/dm-is-sluggable.rb
+lib/dm-is-sluggable/is/sluggable.rb
+lib/dm-is-sluggable/is/version.rb
+spec/integration/sluggable_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.markdown

@@ -0,0 +1,35 @@
+# dm-is-sluggble #
+
+DataMapper plugin that allows records to be found as a slug, mostly
+used in pretty urls.
+
+
+## Example DataMapper resource (i.e. model) ##
+
+    # /app/models/post.rb
+    class Post
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :slug, String
+      
+      is :sluggable
+      
+    end
+    
+    @post = Post.create
+    @post.slug # => "@1"
+    Post.by_slug # => @post
+    
+    @post.update_attributes(:slug => 'some-slug-here')
+    @post.slug # => "some-slug-here"
+    Post.by_slug # => @post
+
+## Example Merb route ##
+
+    # /config/routes.rb
+    identify(Post => :slug) do
+      resources :posts
+    end
+    
+    # url(:post, 1) => /posts/some-slug-here

data/README.txt

@@ -0,0 +1,5 @@
+= dm-is-sluggable
+
+== DESCRIPTION:
+
+See README.markdown

data/Rakefile

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-is-sluggable/is/version'
+
+AUTHOR = "Jeremy Boles"
+EMAIL  = "jeremy [a] jeremyboles [d] com"
+GEM_NAME = "dm-is-sluggable"
+GEM_VERSION = DataMapper::Is::Sluggable::VERSION
+GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
+GEM_CLEAN = ["log", "pkg"]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
+
+PROJECT_NAME = "datamapper"
+PROJECT_URL  = "http://github.com/jeremyboles/dm-is-sluggable/tree/master"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "Simple Datamapper plugin for referencing Resources by 'URL slugs'"
+
+require 'hoe'
+ 
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+ 
+# Remove hoe dependency
+class Hoe
+  def extra_dev_deps
+    @extra_dev_deps.reject! { |dep| dep[0] == "hoe" }
+    @extra_dev_deps
+  end
+end
+ 
+hoe = Hoe.new(GEM_NAME, GEM_VERSION) do |p|
+ 
+  p.developer(AUTHOR, EMAIL)
+ 
+  p.description = PROJECT_DESCRIPTION
+  p.summary = PROJECT_SUMMARY
+  p.url = PROJECT_URL
+ 
+  p.rubyforge_name = PROJECT_NAME if PROJECT_NAME
+ 
+  p.clean_globs |= GEM_CLEAN
+  p.spec_extras = GEM_EXTRAS if GEM_EXTRAS
+ 
+  GEM_DEPENDENCIES.each do |dep|
+    p.extra_deps << dep
+  end
+ 
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
+end
+
+task :cultivate do
+  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
+  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/TODO

@@ -0,0 +1,2 @@
+TODO
+====

data/lib/dm-is-sluggable.rb

@@ -0,0 +1,19 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~>0.9.7'
+require 'dm-core'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-sluggable' / 'is' / 'sluggable.rb'
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Is::Sluggable
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/lib/dm-is-sluggable/is/sluggable.rb

@@ -0,0 +1,37 @@
+module DataMapper
+  module Is
+    module Sluggable
+
+      def is_sluggable(options={})
+        options = { :identifier => '@', :on => :slug, :splitter => '-' }.merge(options)
+        
+        self.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def by_#{options[:on]}(slug)
+            if slug[0..0] == '#{options[:identifier]}'
+              id = slug[1..(slug.length - 1)].split('#{options[:splitter]}')
+              get(id)
+            else
+              first(:#{options[:on]} => slug) || raise(DataMapper::ObjectNotFoundError, "Could not find \#{self.name} with slug \#{slug}")
+            end
+          end
+        RUBY
+        
+        define_method(options[:on]) do
+          instance_variable_get("@#{options[:on]}") || options[:identifier] + key.map.join(options[:splitter])
+        end
+      end
+
+      module ClassMethods
+        def by_slug(slug)
+          if slug[0..0] == '@'
+            id = slug[1..(slug.length - 1)]
+            get!(id)
+          else
+            first(:slug => slug) || raise(DataMapper::ObjectNotFoundError, "Could not find #{self.name} with slug #{slug}")
+          end
+        end
+      end # ClassMethods
+
+    end # Sluggable
+  end # Is
+end # DataMapper

data/lib/dm-is-sluggable/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Sluggable
+      VERSION = '0.9.8'
+    end
+  end
+end

data/spec/integration/sluggable_spec.rb

@@ -0,0 +1,44 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+class Post
+  include DataMapper::Resource
+ 
+  property :id, Integer, :serial => true
+  property :slug, String
+
+  is :sluggable
+ 
+end
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Sluggable' do
+    before(:each) do
+      Post.auto_migrate!
+      @post = Post.create
+    end
+    
+    describe 'without a slug' do
+      it 'should return the id' do
+        @post.slug.should == "@#{@post.id}"
+      end
+      
+      it 'be able to be found by id' do
+        Post.by_slug("@#{@post.id}").should == @post
+      end
+    end
+    
+    describe 'with a slug' do
+      before(:each) { @post.update_attributes(:slug => 'a-slug') }
+      
+      it 'should return slug' do
+        @post.slug.should == 'a-slug'
+      end
+      
+      it 'be able to be found by id' do
+        Post.by_slug('a-slug').should == @post
+      end
+    end
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-sluggable'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '~>0.9.8'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: jeremyboles-dm-is-sluggable
+version: !ruby/object:Gem::Version 
+  version: 0.9.8
+platform: ruby
+authors: 
+- Jeremy Boles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: Simple Datamapper plugin for referencing Resources by 'URL slugs'
+email: 
+- jeremy [a] jeremyboles [d] com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- LICENSE
+- TODO
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.markdown
+- Rakefile
+- TODO
+- lib/dm-is-sluggable.rb
+- lib/dm-is-sluggable/is/sluggable.rb
+- lib/dm-is-sluggable/is/version.rb
+- spec/integration/sluggable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/jeremyboles/dm-is-sluggable/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: datamapper
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple Datamapper plugin for referencing Resources by 'URL slugs'
+test_files: []
+