carpeliam-dm-slug 0.9.8

data/History.txt

@@ -0,0 +1 @@
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Liam Morley
+
+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,13 @@
+History.txt
+LICENSE
+Manifest.txt
+README.markdown
+Rakefile
+TODO
+lib/dm-slug.rb
+lib/dm-slug/has/slug.rb
+lib/dm-slug/has/version.rb
+spec/integration/slug_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/hoe.rb

data/README.markdown

@@ -0,0 +1,29 @@
+dm-slug
+=======
+
+Manages your permalinks so you don't have to.
+
+Internally, makes use of `DataMapper::Types::Slug`, although I'm not terribly
+excited about its implementation at the moment. (After you save a model, you
+have to reload it to be able to see a proper value for the slug field.)
+
+To use, add the following to your model:
+
+    has_slug # uses defaults of :on => name, :called => :slug
+
+or
+
+    has_slug :on => title, :called => permalink
+
+You can add a `:length` option as well, though if you place your `has_slug`
+anywhere below the property given in `:on`, it will pick up the length of that
+field and use that instead. It will also add a `unique_index` option if the
+original field has `unique_index` set to true, or if it's a key.
+
+As shown above, if your field to create a slug on is called `:name` or if you
+don't mind your slug field being called `slug`, then you can leave that
+corresponding option out, as those are the defaults. If you'd like something
+different, as in the second example, you can specify them and they'll get used
+instead of the defaults.
+
+Let me know if there's anything additional you'd like to see here.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-slug/has/version'
+
+AUTHOR = "Liam Morley"
+EMAIL  = "liam@carpeliam.com"
+GEM_NAME = "dm-slug"
+GEM_VERSION = DataMapper::Has::Slug::VERSION
+GEM_DEPENDENCIES = [
+  ["dm-core", GEM_VERSION],
+  ["dm-validations", GEM_VERSION],
+  ["dm-types", GEM_VERSION]
+]
+GEM_CLEAN = ["log", "pkg", "coverage"]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.markdown LICENSE TODO ] }
+
+PROJECT_NAME = "dm-slug"
+PROJECT_URL  = "http://www.github.com/carpeliam/dm-slug/tree/master"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "Manages your slug so you don't have to."
+
+require ROOT + 'tasks/hoe'
+
+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
+
+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-slug/has/slug.rb

@@ -0,0 +1,30 @@
+module DataMapper
+  module Has
+    module Slug
+
+      ##
+      # Methods that should be included in DataMapper::Model.
+      # Normally this should just be your generator, so that the namespace
+      # does not get cluttered. ClassMethods and InstanceMethods gets added
+      # in the specific resources when you fire is :example
+      ##
+
+      def has_slug(options = {})
+        options = { :on => :name, :called => :slug, :length => 50 }.merge(options)
+        
+        if properties.has_property? options[:on]
+          p = properties[options[:on]]
+          p_opts = {:length => p.length, :lazy => p.lazy?, :nullable => p.nullable?,
+            :unique_index => (p.unique or p.unique_index)}
+        else
+          p_opts = {:length => options[:length]}
+        end
+        property options[:called], DataMapper::Types::Slug, p_opts
+          
+        before :valid? do
+          attribute_set(options[:called], self.send(options[:on]))
+        end
+      end
+    end # Slug
+  end # Has
+end # DataMapper

data/lib/dm-slug/has/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Has
+    module Slug
+      VERSION = "0.9.8"
+    end
+  end
+end

data/lib/dm-slug.rb

@@ -0,0 +1,24 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~>0.9.8'
+require 'dm-core'
+#gem 'dm-validations', '~>0.9.8'
+require 'dm-validations'
+#gem 'dm-types', '~>0.9.8'
+require 'dm-types'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-slug' / 'has' / 'slug.rb'
+
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Has::Slug
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/spec/integration/slug_spec.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+class NameExample
+  include DataMapper::Resource
+  has_slug
+  property :id, Serial
+  property :name, String
+end
+
+class TitleExample
+  include DataMapper::Resource
+  property :id, Serial
+  property :title, String, :length => 75, :unique_index => true
+  has_slug :on => :title
+end
+
+class AlternateFieldExample
+  include DataMapper::Resource
+  property :id, Serial
+  property :title, String
+  has_slug :on => :title, :called => :permalink
+end
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  
+  describe 'DataMapper::Has::Slug' do
+    before do
+      DataMapper.auto_migrate!
+    end
+    it "should create a slug field" do
+      ne = NameExample.create :name => 'foo bar'
+      ne.respond_to? :slug
+    end
+    
+    it "should have a slug field that matches the given name" do
+      ne = NameExample.create :name => 'foo bar'
+      NameExample.first.slug.should == 'foo-bar'
+    end
+    
+    it "should accept an :on option" do
+      te = TitleExample.create :title => 'foo bar'
+      TitleExample.first.slug.should == 'foo-bar'
+    end
+    
+    it "should respect the length of the :on field if known" do
+      TitleExample.properties[:slug].length.should == 75 # TitleExample.properties[:title].length
+      TitleExample.properties[:slug].unique_index.should == true # TitleExample.properties[:title].unique_index
+    end
+    
+    it "should accept a :named option" do
+      afe = AlternateFieldExample.create :title => 'foo bar'
+      AlternateFieldExample.first.permalink.should == 'foo-bar'
+    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-slug'
+
+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')

data/tasks/hoe.rb

@@ -0,0 +1,49 @@
+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
+  
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+ 
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: carpeliam-dm-slug
+version: !ruby/object:Gem::Version 
+  version: 0.9.8
+platform: ruby
+authors: 
+- Liam Morley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-14 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: 
+- !ruby/object:Gem::Dependency 
+  name: dm-validations
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-types
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: Manages your slug so you don't have to.
+email: 
+- liam@carpeliam.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- LICENSE
+- TODO
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.markdown
+- Rakefile
+- TODO
+- lib/dm-slug.rb
+- lib/dm-slug/has/slug.rb
+- lib/dm-slug/has/version.rb
+- spec/integration/slug_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/hoe.rb
+has_rdoc: true
+homepage: http://www.github.com/carpeliam/dm-slug/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+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: dm-slug
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Manages your slug so you don't have to.
+test_files: []
+