permalink_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e5ca25f2e8325e1cd27c4917e7f24788463976f
+  data.tar.gz: c2e0473342ecf313182634455271c4aafe0f05b2
+SHA512:
+  metadata.gz: 3d10c7b9f16906fea1ee8b261c85ece4cf086f8b268d9401f3637455a53d62a8f46587cfcb13fe31f2e24e56e0a16901933edd0b4add280326faf769c3231aa0
+  data.tar.gz: ee5a412f25771d0e08e1e5b3b87fe70364f9e4c48b832f04e0373e91d069d0cc60509056b367f6c61b61b761b88d24f95f282c2ccb41c8004dedb749904d862b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.sublime-project
+*.sublime-workspace
+*.dump
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sk@httplab.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,30 @@
+# PermalinkFor
+
+Crazy simple alternative to FriendlyId.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'permalink_for'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/permalink_for. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pretty_permalink'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/permalink_for/pretty_impl.rb

@@ -0,0 +1,20 @@
+module PermalinkFor::PrettyImpl
+  extend ActiveSupport::Concern
+
+  def to_param
+    return id if new_record?
+    target_field_value = send(permalink_configuration[:target_field])
+    arr = [id, I18n.transliterate(target_field_value).parameterize]
+    arr.delete('')
+    arr = arr.reverse if self.class.permalink_configuration[:reverse]
+    arr.join('-')
+  end
+
+  module ClassMethods
+    def find(id)
+      position = permalink_configuration[:reverse] ? :last : :first
+      id = id.split('-').send(position).to_i if id.is_a? String
+      super id
+    end
+  end
+end

data/lib/permalink_for/slug_impl.rb

@@ -0,0 +1,57 @@
+module PermalinkFor::SlugImpl
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def permalink_validation_opts
+      return super if defined?(super)
+      {
+        presence: true,
+        uniqueness: true,
+        format: { with: /\A[a-z0-9_-]+\Z/ }
+      }
+    end
+  end
+
+  included do
+    validates :permalink, permalink_validation_opts
+    before_validation :build_permalink
+  end
+
+  def to_param
+    return permalink if permalink.present?
+    id
+  end
+
+  def build_permalink
+    target_field_value = send(permalink_configuration[:target_field])
+
+    return if permalink.present? || target_field_value.blank?
+    permalink_base = I18n.transliterate(target_field_value).parameterize.downcase
+    permalink_candidate = permalink_base
+    generated_permalink = nil
+
+    attempts_number = 100
+    attempts = attempts_number
+    while attempts > 0 && generated_permalink.nil?
+      if self.class.find_by(permalink: permalink_candidate)
+        attempts -= 1
+        permalink_candidate = permalink_base + (attempts_number - attempts).to_s
+      else
+        generated_permalink = permalink_candidate
+      end
+    end
+
+    fail 'Failed to generate permalink' if generated_permalink.nil?
+    self.permalink = generated_permalink
+  end
+
+  module ClassMethods
+    def find(id)
+      if id.is_a?(Array) || id.is_a?(Fixnum) || (id.is_a?(String) && id[/^\d+$/])
+        super
+      else
+        find_by!(permalink: id.to_s.downcase)
+      end
+    end
+  end
+end

data/lib/permalink_for/version.rb

@@ -0,0 +1,3 @@
+module PermalinkFor
+  VERSION = '0.1.0'
+end

data/lib/permalink_for.rb

@@ -0,0 +1,28 @@
+require 'permalink_for/pretty_impl'
+require 'permalink_for/slug_impl'
+require 'permalink_for/version'
+
+module PermalinkFor
+  extend ActiveSupport::Concern
+
+  PERMALINK_TYPES = {
+    slug: SlugImpl,
+    pretty: PrettyImpl
+  }
+
+  module ClassMethods
+    def permalink_for(field, as: :pretty, reverse: false)
+      as = as.to_sym
+      unless PERMALINK_TYPES.has_key? as
+        raise "Unknown permalink type :#{as} (may be :slug or :pretty)"
+      end
+      include PERMALINK_TYPES[as]
+
+      self::ActiveRecord_AssociationRelation.include PERMALINK_TYPES[as]::ClassMethods
+
+      config = { target_field: field, reverse: reverse }
+      cattr_reader :permalink_configuration
+      class_variable_set(:@@permalink_configuration, config)
+    end
+  end
+end

data/permalink_for.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'permalink_for/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'permalink_for'
+  spec.version       = PermalinkFor::VERSION
+  spec.authors       = ['rainrb', 'kovalevsky']
+  spec.email         = ['dev@httplab.ru']
+
+  spec.summary       = 'Slugs for ActiveRecord Models'
+  spec.description   = 'Simple alternative to FriendlyId.'
+  spec.homepage      = 'https://httplab.ru'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: permalink_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rainrb
+- kovalevsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple alternative to FriendlyId.
+email:
+- dev@httplab.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/permalink_for.rb
+- lib/permalink_for/pretty_impl.rb
+- lib/permalink_for/slug_impl.rb
+- lib/permalink_for/version.rb
+- permalink_for.gemspec
+homepage: https://httplab.ru
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Slugs for ActiveRecord Models
+test_files: []