hc-permalink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 978cd5dbb1f687cc5dbe04ba53a1b30efa8991df
+  data.tar.gz: a6dd96b86744843e55e687e7f7ba49ad82436959
+SHA512:
+  metadata.gz: b14723f2f4efce95713afc7aeed53a77b7c532a7020370fadef94e5b4e663a1fa4598fc2e0e02ce5cb3ab59b7256392e0f987a45507ec17048691fae6d755976
+  data.tar.gz: 8ff2d8629b78ced17428109cad84f010eb8a1efb647c130a5daab1f4d0f5bb9017db4d8593bff3a3ad217cdc9331b4102865f1f49ea319144fad4e8fd271001d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hc-permalink.gemspec
+gemspec
+
+gem 'activesupport'
+gem 'russian'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jack Hayter
+
+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,39 @@
+# HC::Permalink
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hc/permalink`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hc-permalink'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hc-permalink
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/hc-permalink.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hc/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(__FILE__)

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/hc-permalink.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hc/permalink/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hc-permalink"
+  spec.version       = HC::Permalink::VERSION
+  spec.authors       = ["Jack Hayter"]
+  spec.email         = ["jack@hockey-community.com"]
+
+  spec.summary       = "Generates URL friendly (and unique) strings of latin characters for use as permalinks"
+  spec.description   = "Transliterates characters into Latin character set and allows for generation of uniuqe variants with an incrementing ID"
+  spec.homepage      = "https://github.com/HockeyCommunity/permalink"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "russian"
+  spec.add_development_dependency "activesupport"
+end

data/lib/hc/permalink.rb

@@ -0,0 +1,127 @@
+require "hc/permalink/version"
+require "active_support/inflector/transliterate"
+require "russian"
+
+module HC
+  module Permalink
+
+    @@shared_resource_classes = []
+
+    def self.shared_resource_classes=(class_list)
+      raise "Class list must be an array of classes" unless class_list.is_a?(Array)
+      @@shared_resource_classes = class_list.dup
+    end
+
+    def self.shared_resource_classes
+      @@shared_resource_classes
+    end
+
+    def self.generate_unique(value:, target_class:, target_field: 'permalink', ignore_id: nil, constraint: nil)
+
+      # Create a base name which we will later increment
+      #
+      base_value    = self.from_string(value, remove_spaces: true).to_s[0..63]
+      current_value = base_value
+      counter       = 0
+
+      # Loop on finding objects with these parameters until no object found
+      #
+      while self.locate_object(target_class: target_class, target_field: target_field, target_value: current_value, ignore_id: ignore_id, constraint: constraint)
+        counter += 1
+        current_value = "#{base_value[0..(63 - counter.to_s.length)]}#{counter}"
+      end
+
+      # Return the current generated value
+      #
+      return current_value
+
+    end
+
+    def self.from_string(value, remove_spaces: false)
+
+      # Replace spaces and underscores with hyphens, then replace all
+      # other common punctuation and symbols, then downcase the result
+      #
+      value = value.to_s.gsub(/[\s_]+/,'-').gsub(/[!"#$%&'\(\)*+,\.\/:;<=>?@\[\\\]\^_`{}¦|£¬~]+/, '').gsub(/[-]{2,}/, '-')
+      value = value.gsub('-','') if remove_spaces
+
+      # Attempt to Transliterate Russian and latin-based characters
+      # with accents into their latin(ish) equivalents
+      #
+      value = I18n.transliterate(Russian::transliterate(value).gsub('ș', 's').gsub('ț', 't').gsub('ồ', 'o').gsub('ế', 'e').gsub('ộ', 'o').gsub('ạ', 'a')).downcase.gsub("?", "")
+
+      # Return the resulting slug, but remove any trailing hyphens
+      #
+      return value[/[\w-]*\w/]
+
+    end
+
+    def self.simple(value)
+      value.to_s.gsub(/[\s-]+/,'_').gsub(/[^\w]+/, '').downcase
+    end
+
+    private
+
+    def self.locate_object(target_class:, target_field:, target_value:, ignore_id:, constraint:)
+      self.find_object(
+        target_class: target_class,
+        target_field: target_field,
+        target_value: target_value,
+        ignore_id:    ignore_id,
+        constraint:   constraint
+      ) || self.taken_by_shared_resource?(
+        target_class: target_class,
+        value:        target_value,
+        ignore_own:   true
+      )
+    end
+
+    def self.taken_by_shared_resource?(target_class:, value:, ignore_own: false)
+
+      # No need to check presence of values for irelevent classes
+      #
+      return false unless @@shared_resource_classes.include?(target_class)
+
+      # Identify and class search space
+      #
+      classes_to_search = @@shared_resource_classes.dup
+      classes_to_search = classes_to_search.reject{|k|k==target_class} if ignore_own
+
+      # Loop on search space and try to find something
+      #
+      classes_to_search.each do |shared_target_class|
+        found_object = shared_target_class.find_by_shared_resource_identifier(value)
+        return true if !found_object.nil?
+      end
+
+      # Fall back to false if nothing was found
+      #
+      return false
+
+    end
+
+    def self.find_object(target_class:, target_field:, target_value:, ignore_id: nil, constraint: nil)
+
+      # Ensure that the constraint matches the following format:
+      # constraint: {key: value}
+      #
+      if !constraint.nil?
+        raise "constraint must be a hash containing only one key" if !constraint.is_a?(Hash) || constraint.keys.count > 1
+      end
+
+      # Attempt to find objects matching these constraints
+      #
+      if !constraint.nil?
+        located_objects = target_class.where(target_field.to_sym => target_value).where.not(id: ignore_id).where(constraint)
+      else
+        located_objects = target_class.where(target_field.to_sym => target_value).where.not(id: ignore_id)
+      end
+
+      # Return any results of our lookup
+      #
+      return located_objects.count > 0 ? located_objects.first : nil
+
+    end
+
+  end
+end

data/lib/hc/permalink/version.rb

@@ -0,0 +1,5 @@
+module HC
+  module Permalink
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: hc-permalink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Hayter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: russian
+  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: activesupport
+  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: Transliterates characters into Latin character set and allows for generation
+  of uniuqe variants with an incrementing ID
+email:
+- jack@hockey-community.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hc-permalink.gemspec
+- lib/hc/permalink.rb
+- lib/hc/permalink/version.rb
+homepage: https://github.com/HockeyCommunity/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.6.12
+signing_key: 
+specification_version: 4
+summary: Generates URL friendly (and unique) strings of latin characters for use as
+  permalinks
+test_files: []