active_model-permalink 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea1c85a8f0becc3a0d4523d919c8e197cd09051
+  data.tar.gz: fadbcae6d60cac5b60f317a68883acd3c6f56380
+SHA512:
+  metadata.gz: a4381596a5df365bfb91dfe996b4f8408ba984cd9772c30bc5e9c64053283c4c5d284da637be50b497a18d57c688ca2adaf2a067c26a08d56763647c2a6849ba
+  data.tar.gz: b7738e93e83dcf7d3ebdb668f1b5ba31cd3b59d311652e50b435b7478a70f779621f60e754eedeea691d44702b9b4d95ae9567e1ae47071d66fed6c6aa1d09a9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Attila Györffy
+
+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,58 @@
+# ActiveModel::Permalink
+
+`ActiveModel::Permalink` generates permalinks for your `ActiveModel` objects. It includes support for `Mongoid`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_model-permalink'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model-permalink
+
+## Usage
+
+`ActiveModel::Permalink` generates permalinks for your objects as part of a `before_validation` callback. It uses the following attributes in order to generate from (provided these are present):
+
+* name
+* title
+
+In case the `permalink` attribute is present already, it won't bother to change it. See [the specs](https://github.com/liquid/active_model-permalink/blob/master/spec/lib/active_model/permalink_spec.rb) for more information about the behavior.
+
+### With simple ActiveModel classes
+
+```ruby
+class MyClass
+  # Make sure you are using a real ActiveModel object
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include ActiveModel::Validations::Callbacks
+
+  include ActiveModel::Permalink
+
+  attr_accessor :name, :title, :permalink
+end
+
+my_instance = MyClass.new
+my_instance.name = 'My Name'
+
+my_instance.valid? # this triggers the callback that is used to ensure a permalink is present
+my_instance.permalink
+# => 'my-name'
+```
+
+## 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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/active_model-permalink.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/permalink/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-permalink"
+  spec.version       = ActiveModel::Permalink::VERSION
+  spec.authors       = ["Attila Györffy"]
+  spec.email         = ["attila@attilagyorffy.com"]
+  spec.summary       = %q{Simple permalink solution for ActiveModel objects}
+  spec.description   = %q{ActiveModel::Permalink generates permalinks for your ActiveModel objects, including support for Mongoid.}
+  spec.homepage      = "http://github.com/liquid/active_model-permalink"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "activemodel", [">= 4.0"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/active_model/permalink.rb

@@ -0,0 +1,33 @@
+require 'active_support/concern'
+require "active_model/permalink/version"
+
+module ActiveModel
+  module Permalink
+    
+    CANDIDATE_SOURCE_ATTRIBUTES = [:name, :title]
+    
+    extend ActiveSupport::Concern
+    
+    included do
+      before_validation :ensure_permalink_is_present
+    end
+
+  private
+
+    def ensure_permalink_is_present
+      self.permalink ||= generate_permalink
+    end
+    
+    def generate_permalink
+      source_attribute = ActiveModel::Permalink::CANDIDATE_SOURCE_ATTRIBUTES.detect do |attr|
+        self.respond_to?(attr) && self.send(attr).present?
+      end
+      
+      if source_attribute
+        self.send(source_attribute).dasherize.parameterize
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/active_model/permalink/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module Permalink
+    VERSION = "0.0.1"
+  end
+end

data/spec/lib/active_model/permalink_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe ActiveModel::Permalink do
+  subject { TestClass.new }
+  
+  context 'if permalink is not present' do
+    before do
+      subject.permalink = nil
+    end
+    
+    context 'and :name is present' do
+      before do
+        subject.name = 'Name Of Model'
+        subject.title = 'Title Of Model'
+        subject.valid? # trigger callback
+      end
+      
+      it 'generates from the :name attribute' do
+        expect(subject.permalink).to eql('name-of-model')
+      end
+    end
+    
+    context 'and :name is not present but :title is' do
+      before do
+        subject.name = nil
+        subject.title = 'Title Of Model'
+        subject.valid? # trigger callback
+      end
+      
+      it 'uses the :title attribute to generate the permalink from' do  
+        expect(subject.permalink).to eql('title-of-model')
+      end
+    end
+  end
+  
+  context 'if permalink is present already' do
+
+    before do
+      subject.permalink = 'already-existing'
+      subject.valid? # trigger the callback
+    end
+    
+    it 'respects the value' do
+      subject.permalink = 'already-existing'
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'active_model/permalink'
+require 'support/test_class'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/test_class.rb

@@ -0,0 +1,13 @@
+require 'active_model'
+
+class TestClass  
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include ActiveModel::Validations::Callbacks
+  
+  include ActiveModel::Permalink
+  
+  attr_accessor :name
+  attr_accessor :title
+  attr_accessor :permalink
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: active_model-permalink
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Attila Györffy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: ActiveModel::Permalink generates permalinks for your ActiveModel objects,
+  including support for Mongoid.
+email:
+- attila@attilagyorffy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model-permalink.gemspec
+- lib/active_model/permalink.rb
+- lib/active_model/permalink/version.rb
+- spec/lib/active_model/permalink_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb
+homepage: http://github.com/liquid/active_model-permalink
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple permalink solution for ActiveModel objects
+test_files:
+- spec/lib/active_model/permalink_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb