gastropod 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 James Cook
+
+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,60 @@
+# gastropod
+
+Simple library for generating slugs
+
+![gastropod](http://i.imgur.com/5UhkBfI.jpg)
+
+## Install
+
+1. Update your Gemfile: `gem 'gastropod'`
+2. Add a 'slug' column to your table.
+3. Extend gastropod in your model
+4. Call `assign_generated_slug` to generate a slug
+
+## ActiveRecord Example
+
+    class Product < ActiveRecord::Base
+      extend Gastropod
+      include Gastropod::ActiveRecord::Validations # Roll your own for other ORMs
+
+      # Method to generate a slug against
+      slug :name
+    end
+
+## Sequel Example
+
+    DB = Sequel.connect('sqlite://db/sequel.db')
+
+    DB.create_table? :fruits do
+      primary_key :id
+      String :name
+      String :slug
+    end
+
+    class Fruit < Sequel::Model
+      extend Gastropod
+
+      slug :name
+
+      def before_save
+        assign_generated_slug
+      end
+    end
+
+## Customisation
+
+If you aren't using ActiveRecord, you will likely want to override the class method 'slug_finder'
+
+## Contributing
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 James Cook & Patrick Reagan (Viget). See MIT_LICENSE for further details.

data/gastropod.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "gastropod/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gastropod"
+  s.version     = Gastropod::VERSION
+  s.authors     = ["James Cook", "Patrick Reagan"]
+  s.email       = ["james.cook@viget.com"]
+  s.homepage    = "https://github.com/vigetlabs/gastropod"
+  s.summary     = s.description = "Simple library for generating slugs"
+
+  s.files = Dir["lib/**/*"] + %w(MIT-LICENSE README.md gastropod.gemspec)
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_development_dependency "activerecord", "~> 3.1"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'rspec'
+end

data/lib/gastropod.rb

@@ -0,0 +1,56 @@
+require "gastropod/active_record/validations" if Object.const_defined? "ActiveRecord"
+
+module Gastropod
+  def self.extended(base)
+    base.send(:instance_variable_set, "@slug_source_attribute", "name")
+    base.send(:include, InstanceMethods)
+  end
+
+  def slug(attribute)
+    instance_variable_set("@slug_source_attribute", attribute)
+  end
+
+  def slug_source_attribute
+    @slug_source_attribute
+  end
+
+  def slug_finder
+    instance_variable_defined?("@slug_finder") ? @slug_finder : default_slug_finder
+  end
+
+  def default_slug_finder
+    lambda {|value| where(:slug => value) }
+  end
+
+  module InstanceMethods
+
+    def assign_generated_slug
+      self.slug = next_available_slug if generate_slug?
+    end
+
+    private
+
+    def slug_source
+      send self.class.slug_source_attribute
+    end
+
+    def slug_from_source
+      slug_source.to_s.downcase.gsub(/[^a-zA-Z0-9\-_]+/, '-')
+    end
+
+    def generate_slug?
+      slug_source.present? && slug.blank?
+    end
+
+    def next_available_slug
+      possible_slug = slug_from_source
+
+      index = 2
+      while self.class.slug_finder.call(possible_slug).any?
+        possible_slug = slug_from_source + "-#{index}"
+        index+= 1
+      end
+      possible_slug
+    end
+  end
+end

data/lib/gastropod/active_record/validations.rb

@@ -0,0 +1,13 @@
+module Gastropod
+  module ActiveRecord
+    module Validations
+      def self.included(base)
+        base.validates :slug, :uniqueness => true
+        base.validates :slug, :format     => { :with => /^[a-z0-9-]+$/, :allow_blank => true }
+        base.validates :slug, :presence   => true
+
+        base.before_validation :assign_generated_slug, :if => :generate_slug?
+      end
+    end
+  end
+end

data/lib/gastropod/version.rb

@@ -0,0 +1,3 @@
+module Gastropod
+  VERSION = "0.1.0"
+end

data/spec/fixtures/product.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "spec/db/activerecord.db")
+
+class Product < ActiveRecord::Base
+  extend Gastropod
+  include Gastropod::ActiveRecord::Validations
+
+  slug :name
+end

data/spec/lib/gastropod_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+require "fixtures/product"
+
+Product.connection.execute "DROP TABLE IF EXISTS products;"
+Product.connection.execute "CREATE TABLE products (id INTEGER PRIMARY KEY , name VARCHAR(255), slug VARCHAR(255));"
+
+describe Gastropod do
+  it "can create a slug" do
+    product = Product.create!(:name => "HELLO WORLD")
+    product.slug.should == "hello-world"
+  end
+
+  it "can handle creating a unique slug" do
+    product1 = Product.create!(:name => "jimmy boy")
+    product2 = Product.create!(:name => "jimmy boy")
+
+    product2.slug.should == "jimmy-boy-2"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "active_record"
+require "gastropod"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: gastropod
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Cook
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple library for generating slugs
+email:
+- james.cook@viget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gastropod/active_record/validations.rb
+- lib/gastropod/version.rb
+- lib/gastropod.rb
+- MIT-LICENSE
+- README.md
+- gastropod.gemspec
+- spec/db/activerecord.db
+- spec/db/fixtures.sqlite3
+- spec/db/sequel.db
+- spec/fixtures/product.rb
+- spec/lib/gastropod_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vigetlabs/gastropod
+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.23
+signing_key: 
+specification_version: 3
+summary: Simple library for generating slugs
+test_files:
+- spec/db/activerecord.db
+- spec/db/fixtures.sqlite3
+- spec/db/sequel.db
+- spec/fixtures/product.rb
+- spec/lib/gastropod_spec.rb
+- spec/spec_helper.rb