shigeru 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35c7d95ef534f5cb70343ad87648446a45249252
+  data.tar.gz: 6c8f52e52c6d9adabc957ab781eed40dc14ad082
+SHA512:
+  metadata.gz: a03c5e0f19ba300904e7dc478ccdba6a5a4eb540e65f1b083ba9500d44764f11c82fdae4492507463db914706015a9b4960ff659dd7771289842fc1ead38d89b
+  data.tar.gz: 2aab28e69906f70badbe1a06fea619f9281dd949d2e740091bd3e3eb2d2d44e229881d6b8656fac1064508f8a14e14315bf4e00d183e03c8c1825011cffe1ef4

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/pkg

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+We welcome any kind of contribution: Documentation, code, issues, discussions, critique, speaking about it...
+
+The tests are written using [cutest](https://github.com/djanowski/cutest). Please describe all new features with tests.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lucas Dohmen
+
+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,67 @@
+# Shigeru [![build status](https://travis-ci.org/moonglum/shigeru.svg)](https://travis-ci.org/moonglum/shigeru)
+
+Shigeru helps you with the links and HTTP-URIs in your application. It is supposed to be a simpler version of what Rails offers. It is named after [Shigeru Miyamoto](https://en.wikipedia.org/wiki/Shigeru_Miyamoto), the creator of Link.
+
+**Shigeru is in an experimental phase while we figure out how to offer a simple `uri_for` helper that is agnostic of routing libraries. As it has not reached 1.0 yet, anything can change at any time. As soon as it stabilizes this will be marked by the 1.0 release.**
+
+
+# Concept
+
+In REST, Fielding defines four interface constraints. One of them is the *identification of resources*. This library tries to simplify that in the scope of an HTTP based web application. In order to do that, Shigeru offers a mapping from a resource to a resource identifier (in our case a URI as we are talking about HTTP based web applications). Fielding states a few examples for what a resource might be:
+
+> Any information that can be named can be a resource: a document or image, a temporal service (e.g. "today's weather in Los Angeles"), a collection of other resources, a non-virtual object (e.g. a person), and so on. In other words, any concept that might be the target of an author's hypertext reference must fit within the definition of a resource.
+>   -- Architectural Styles and the Design of Network-based Software Architectures, section 5.2.1.1: Resources and Resource Identifiers - [Roy Thomas Fielding](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm#sec_5_2)
+
+Shigeru does not care about how your URIs look (in the same way that REST doesn't care about that). For Shigeru `/users/12` is as valid as `/createAllTheThings` or `/xaa/12/xhy`. We don't judge you.
+
+In Shigeru, you first define a route. Then you can use this definition throughout your code. For example:
+
+```ruby
+require 'shigeru'
+
+routes = Shigeru::Repository.new
+routes.define :users, '/users'
+
+# Somewhere later:
+routes.uri_for(:users) #=> '/users'
+```
+
+Shigeru supports a subset of [URI templates](https://tools.ietf.org/html/rfc6570), Level 4 to make your URIs dynamic. It supports the simple insertion of a parameter:
+
+```ruby
+routes.define :user, '/users/{id}'
+routes.uri_for(:user, id: 13) #=> '/users/13'
+```
+
+It is also possible to explode a parameter (this is noted with a `*` suffix for that variable). It then expects an array instead of a single value:
+
+```ruby
+routes.define :users, '/users/{ids*}'
+routes.uri_for(:users, ids: [13,15]) #=> '/users/13,15'
+```
+
+It is also possible to insert query parameters. To do that, you add a question mark as the first character in your curly braces (we call this the sigil). It is possible to insert one or more variables in one curly brace:
+
+```ruby
+routes.define :users, '/users{?name,country}'
+routes.uri_for(:users, name: 'alice', country: 'argentina') #=> '/users?name=alice&country=argentina'
+```
+
+Finally, we can add route parameters. Again, we can use both explode modifiers as well as multiple parameters in one insertion:
+
+```ruby
+routes.define :users, '/users{/xs*}'
+routes.uri_for(:users, xs: ['alice', 'bob']) #=> '/users/alice/bob'
+```
+
+## Design
+
+The implementation of Shigeru is inspired by [Michel Martens](https://github.com/soveran)' [mote](https://github.com/soveran/mote) and the [codalyzed video about it](https://codalyzed.com/videos/lesscode). It trades performance (only executing a proc when calling `uri_for` that doesn't need to parse the template) against a slightly hairy implementation (building Ruby code by String concatenation and `eval`ing it :scream:).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/moonglum/shigeru). You can find more information about contributing in the [CONTRIBUTING.md](https://github.com/moonglum/shigeru/blob/master/CONTRIBUTING.md). This project is intended to be a safe, welcoming space for collaboration and discussion, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## 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,8 @@
+require "bundler/gem_tasks"
+
+desc 'Run the test suite'
+task :test do
+  exec "cutest test/*.rb"
+end
+
+task :default => :test

data/lib/shigeru.rb

@@ -0,0 +1,68 @@
+require "shigeru/version"
+require "uri"
+
+module Shigeru
+  class Repository
+    def initialize
+      @mapping = {}
+    end
+
+    def define(name, template)
+      @mapping[name] = UriTemplate.new(template)
+    end
+
+    def uri_for(name, parameters={})
+      @mapping.fetch(name).expand(parameters)
+    end
+  end
+
+  # Handles a subset of [URI Template](https://tools.ietf.org/html/rfc6570), Level 4
+  class UriTemplate
+    PATTERN = /{([\?\/]?)([\w,*]+)}/
+
+    def initialize(template)
+      terms = template.split(PATTERN)
+      parts = ["Proc.new do |params, __o|", "params ||= {}", "__o ||= ''"]
+      while (term = terms.shift)
+        case term
+        when '' then parts.push(expansion('', ',', terms.shift.split(',')))
+        when '?' then parts.push(expansion('?', '&', terms.shift.split(',')))
+        when '/' then parts.push(expansion('/', '/', terms.shift.split(',')))
+        else parts << "__o << '#{term}'"
+        end
+      end
+      parts.push("__o", "end")
+      @template = self.instance_eval(parts.join("\n"))
+    end
+
+    def expand(parameters)
+      @template[parameters]
+    end
+
+    private
+
+    def expansion(sigil, seperator, terms)
+      result = []
+
+      case sigil
+      when '?' then result << "__o << '?'"
+      when '/' then result << "__o << '/'"
+      end
+
+      while (term = terms.shift)
+        if term[-1] == '*'
+          result << "__o << params[:#{term[0...-1]}].map do |t|"
+          result << "  '#{term[0...-1]}=' +" if sigil == '?'
+          result << "  URI.escape(t.to_s)"
+          result << "end.join('#{seperator}')"
+        else
+          result << "__o << '#{term}='" if sigil == '?'
+          result << "__o << URI.escape(params[:#{term}].to_s)"
+        end
+        result << "__o << '#{seperator}'" if terms.any?
+      end
+
+      result
+    end
+  end
+end

data/lib/shigeru/version.rb

@@ -0,0 +1,3 @@
+module Shigeru
+  VERSION = "0.1.0"
+end

data/shigeru.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shigeru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shigeru"
+  spec.version       = Shigeru::VERSION
+  spec.authors       = ["Lucas Dohmen"]
+  spec.email         = ["lucas@dohmen.io"]
+
+  spec.summary       = %q{A routing library agnostic uri_for helper}
+  spec.description   = %q{Define routes for your apps independent of your routing. Then generate your URIs with a uri_for helper.}
+  spec.homepage      = "https://github.com/moonglum/shigeru"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "cutest", "~> 1.2.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: shigeru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Dohmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !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'
+description: Define routes for your apps independent of your routing. Then generate
+  your URIs with a uri_for helper.
+email:
+- lucas@dohmen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shigeru.rb
+- lib/shigeru/version.rb
+- shigeru.gemspec
+homepage: https://github.com/moonglum/shigeru
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A routing library agnostic uri_for helper
+test_files: []