inferred_slug 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    inferred_slug (0.0.7)
+      activerecord
+      stringex
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.3.5)
+    stringex (1.4.0)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  inferred_slug!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rafael Fernández López <ereslibre@ereslibre.es>
+
+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.rdoc

@@ -0,0 +1,84 @@
+== What is Inferred Slug ?
+
+Most slug engines require you to modify your database schema to save slugs in
+it. The idea behind Inferred Slug is that slugs can be inferred and treated as
+logic, instead of being treated as data.
+
+This gem is compatible with the rest of slug engines, as far as I know. If you
+find any incompatibility, I'd be glad to hear about it, so I can fix it.
+
+== Why yet another slug engine ?
+
+I started to search for gems providing slug support. I have to say there are
+really great slug engines out there. However, I couldn't find any slug engine
+able to work without a database. So I implemented it. Is dead simple.
+
+== Advantages
+
+1. Avoid duplicated data in your database. You need to take care of the slugs
+   in the case they aren't permanent, by installing ActiveRecord callbacks for
+   updating it. Forgetting installing a callback could mean that you have
+   inconsistent and misleading information (e.g. '/users/23-john-doee' could
+   actually show user 'John Doe' because he updated his profile to fix the typo).
+
+2. Prettify URL's.
+
+3. Secure your ID's. Avoid the typical random script that will just increase an
+   ID, and will find out random information about your users/clients.
+
+4. Save space in database. While the database grows, slugs are also taking its
+   part in consuming space.
+
+5. Compatible with other slug engines. You can still use friendly_id wherever
+   you want (or any other slug engine). You can decide on which models you want
+   to use Inferred Slugs, and avoid saving slugs of that particular model in the
+   database.
+
+== Disadvantages
+
+1. You cannot set permalinks with this slugs. Since the slug itself is inferred
+   from the data of the record, you cannot relay on that (unless that field is
+   immutable by design on your application) to provide permalinks.
+
+2. The ID is shown. Resources on the location bar is of the form '3-test-foo'.
+   Given the design, there is no way of removing it.
+
+== Installing
+
+1. Add 'inferred_slug' to your Gemfile.
+2. Optional: run 'rails g inferred_slug:install'
+
+The optional step will include slugs on all your models automatically, by
+installing an initializer that adds slugs to ActiveRecord::Base, superclass of
+all your models. Thus, all your models magically have slugs.
+
+If you want to specify slugs on a per-model basis, you can skip step 2 (or
+delete the config/initializers/slug.rb file if you already ran it), and
+explicitly include InferredSlug::Slug on the models that you want to have slugs.
+
+== How it works
+
+Right now is very simple. It will check if your model contains a 'name' column,
+and in that case, the resource will automatically be called '#{id}-#{name}'. Now
+let's suppose you have a Post model that instead of name has a title column, and
+you want to use that as the slug:
+
+  class Post < ActiveRecord::Base
+    include InferredSlug::Slug # Only necessary if the initializer isn't installed
+
+    def slug
+      "#{id}-#{title}"
+    end
+  end
+
+== Working with it
+
+You have now two methods that will allow you to search by slugs:
+
+1. find_by_slug
+2. find_by_slug!
+
+They are finder methods, so they are also in collections. Examples:
+
+1. Client.find_by_slug '1-john-doe'
+2. Client.first.users.find_by_slug '54-alice-smith'

data/inferred_slug.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'inferred_slug/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'inferred_slug'
+  s.version     = InferredSlug::VERSION
+  s.summary     = 'Library for adding slugs on your Rails application'
+  s.description = 'Library for easily adding slugs on your Rails application without the need of database storage'
+  s.authors     = ['Rafael Fernández López']
+  s.email       = 'ereslibre@ereslibre.es'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/ereslibre/inferred_slug'
+
+  s.add_dependency('stringex')
+  s.add_dependency('activerecord')
+end

data/lib/generators/inferred_slug/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module InferredSlug
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      desc "This generator installs inferred slugs on all your models"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_slug_hook
+        say_status "copying", "slug global hook", :green
+        copy_file "slug.rb", "config/initializers/slug.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/inferred_slug/install/templates/slug.rb

@@ -0,0 +1,12 @@
+#
+# This generator automatically adds slugs to all your models. If you want to use
+# inferred slugs on individual models, delete this file and make your desired
+# models include the 'InferredSlug::Slug' module. This is:
+#
+#   class MyModel < ActiveRecord::Base
+#     include InferredSlug::Slug
+#   end
+#
+class ActiveRecord::Base
+  include InferredSlug::Slug
+end

data/lib/inferred_slug/finders.rb

@@ -0,0 +1,23 @@
+require 'active_record'
+
+module InferredSlug
+  module Finders
+
+    def find_by_slug(*args)
+      record = find(*args)
+      if record and record.respond_to?(:slug)
+        return nil unless record.slug == args.first
+      end
+      record
+    end
+
+    def find_by_slug!(*args)
+      find_by_slug(*args) or raise ActiveRecord::RecordNotFound
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  extend InferredSlug::Finders
+end

data/lib/inferred_slug/slug.rb

@@ -0,0 +1,19 @@
+require 'stringex'
+
+module InferredSlug
+  module Slug
+
+    def slug
+      if not respond_to?(:name) or name.empty?
+        id
+      else
+        "#{id}-#{name}".to_url
+      end
+    end
+
+    def to_param
+      slug
+    end
+
+  end
+end

data/lib/inferred_slug/version.rb

@@ -0,0 +1,3 @@
+module InferredSlug
+  VERSION = '1.0.0'
+end

data/lib/inferred_slug.rb

@@ -0,0 +1,2 @@
+require 'inferred_slug/slug'
+require 'inferred_slug/finders'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: inferred_slug
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rafael Fernández López
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for easily adding slugs on your Rails application without the
+  need of database storage
+email: ereslibre@ereslibre.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- inferred_slug.gemspec
+- lib/generators/inferred_slug/install/install_generator.rb
+- lib/generators/inferred_slug/install/templates/slug.rb
+- lib/inferred_slug.rb
+- lib/inferred_slug/finders.rb
+- lib/inferred_slug/slug.rb
+- lib/inferred_slug/version.rb
+homepage: https://github.com/ereslibre/inferred_slug
+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.21
+signing_key: 
+specification_version: 3
+summary: Library for adding slugs on your Rails application
+test_files: []