slugworth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04ab52605f883c0def4b390bcc679b8ca3e02e1b
+  data.tar.gz: 015b1c107147250b77fb16e89c5cb21577982c29
+SHA512:
+  metadata.gz: cf4eafd11571e1243cc29e9e40b9589fc9cebfa435785ca2f9523dbf0b7eb5864b9d7cdf11c57cc60d23937fe0187ba0b1edc9f703ec0c0c0124603575b5b527
+  data.tar.gz: 595902d54c36d528dc60a9a47544eccd56ab0fc990da6d56044ce3c3f71153c0f52c3a94d4dd3fb7e9a7904d3f278a461f2edef8b62901f241e1ec33e863a858

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/.ruby-gemset

@@ -0,0 +1 @@
+slugworth

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slugworth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Polito
+
+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,56 @@
+# Slugworth
+
+[![Gem Version](https://badge.fury.io/rb/slugworth.png)](http://badge.fury.io/rb/sluggle)
+[![Build Status](https://travis-ci.org/mattpolito/slugworth.png?branch=master)](https://travis-ci.org/mattpolito/sluggle)
+[![Code Climate](https://codeclimate.com/github/mattpolito/slugworth.png)](https://codeclimate.com/github/mattpolito/sluggle)
+
+Simple slug functionality for your ActiveRecord objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```shell
+  gem 'slugworth'
+```
+
+and then execute
+
+```shell
+  bundle
+```
+
+or
+
+install it yourself with
+
+```shell
+  gem install slugworth
+```
+
+## Usage
+
+Getting started is easy! Just ensure that your model has a database column of type `String` called `slug`
+
+To use just add two declarations to your module and away you go!
+
+```ruby
+class User < ActiveRecord::Base
+  include Slugworth
+  slugged_with :name
+end
+```
+
+This provides most of the default slug functionality you would need.
+
+* A finder `.find_by_slug` is provided. This will, of course, do what you expect and find a single record by the slug attribute provided. However, it will throw an `ActiveRecord::RecordNotFound` exception... if not found.
+* `#to_param` has been defined as a paramaterized version of the attribute declared to `slugged_with`.
+* Validations stating that slug is present and unique in the database.
+
+## 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/slugworth.rb

@@ -0,0 +1,32 @@
+require "slugworth/version"
+
+module Slugworth
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_accessor :slug_attribute
+    before_validation(:add_slug)
+    validates_uniqueness_of :slug
+  end
+
+  module ClassMethods
+    def slugged_with(slug_attribute)
+      self.slug_attribute = slug_attribute
+    end
+
+    def find_by_slug(slug)
+      find_by!(slug: slug)
+    end
+  end
+
+  def to_param; slug; end
+
+  private
+  def add_slug
+    self.slug = processed_slug unless slug.present?
+  end
+
+  def processed_slug
+    send(slug_attribute).parameterize
+  end
+end

data/lib/slugworth/version.rb

@@ -0,0 +1,3 @@
+module Slugworth
+  VERSION = "1.0.0"
+end

data/lib/slugworth_shared_examples.rb

@@ -0,0 +1,58 @@
+shared_examples_for :has_slug_functionality do
+  describe "#slug" do
+    context "when no slug is set" do
+      specify 'slug is generated' do
+        obj = described_class.new(described_class.slug_attribute => 'Generated slug')
+        obj.valid?
+        expect(obj.slug).to eq('generated-slug')
+      end
+    end
+
+    context "when the slug is set" do
+      specify 'slug is set to passed value' do
+        obj = described_class.new(slug: 'passed-slug')
+        obj.valid?
+        expect(obj.slug).to eq('passed-slug')
+      end
+    end
+
+    context "when slug is already taken" do
+      before do
+        existing = described_class.new(slug: 'taken-slug')
+        existing.save(validate: false)
+      end
+
+      specify "object is not valid" do
+        obj = described_class.new(slug: 'taken-slug')
+        obj.valid?
+        expect(obj.errors[:slug]).to_not be_empty
+      end
+    end
+  end
+
+  describe '#to_param' do
+    specify 'parameter uses slug' do
+      obj = described_class.new(slug: 'passed-slug')
+      expect(obj.to_param).to eq('passed-slug')
+    end
+  end
+
+  describe ".find_by_slug" do
+    context 'when record is available to be found' do
+      before do
+        User.create(slug: 'named-slug')
+      end
+
+      specify 'record is returned' do
+        record = described_class.find_by_slug('named-slug')
+        expect(record).to be_present
+      end
+    end
+
+    context 'when record is not found' do
+      specify 'error is returned' do
+        expect { described_class.find_by_slug('named-slug') }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end

data/slugworth.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slugworth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slugworth"
+  spec.version       = Slugworth::VERSION
+  spec.authors       = ["Matt Polito"]
+  spec.email         = ["matt.polito@gmail.com"]
+  spec.description   = %q{Easy slug functionality}
+  spec.summary       = %q{Easy slug functionality}
+  spec.homepage      = "https://github.com/mattpolito/slugworth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency 'activerecord', '~> 4.0.0'
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/sluggle_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'slugworth_shared_examples'
+require 'slugworth'
+
+ActiveRecord::Base.connection.execute(
+  %{CREATE TABLE users (id INTEGER PRIMARY KEY, name STRING, slug STRING);}
+)
+
+class User < ActiveRecord::Base
+  include Slugworth
+  slugged_with :name
+end
+
+describe User do
+  it_behaves_like :has_slug_functionality
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'database_cleaner'
+
+require 'active_support/concern'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3', database: ':memory:'
+)
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: slugworth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Polito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy slug functionality
+email:
+- matt.polito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slugworth.rb
+- lib/slugworth/version.rb
+- lib/slugworth_shared_examples.rb
+- slugworth.gemspec
+- spec/sluggle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mattpolito/slugworth
+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.3
+signing_key: 
+specification_version: 4
+summary: Easy slug functionality
+test_files:
+- spec/sluggle_spec.rb
+- spec/spec_helper.rb