rails_templated_urls 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5589bbdb5208706c2d1f25d1ae1f4da922abc40e
-  data.tar.gz: e9d74cdc8550befeb68635c3c13cc25ca6acbe55
+  metadata.gz: 760d59f73f0f27a9f981644d3720e604203b0f3a
+  data.tar.gz: 5bd78dd7c05b22ac1e4f166530c0c96a9465037c
 SHA512:
-  metadata.gz: fde8250e5b2dc486d4bf3d05c90fd8a3a06bd6eaf0c52107b623319ae6f9e4d493aff58b5215b1a344124c653bebc012274fbc4b52117bc4539f54e544a6e20c
-  data.tar.gz: 4aa634f68b097e8dce221310cc0fdba2adfdfe6ad0f34d561f6708eaec090d9ccd442bea888484063cfedbdff03e491b1d138edcf4b3e5b02c5acb8a5797cf9a
+  metadata.gz: 840b7d47ed1ab8556b3a5ed7232bdad62ab376b071402fa4f55afd7b861ce37e56897070799ee38fbffe61dbfcbd1073a9167a23226da27394a158d5da6f25f2
+  data.tar.gz: 579128c5fcc116976aeacfc71942338ca6d5ec1e48c9df087daab9b4b3f6f9581d53863ffae0a411902e91f428e7edb3ce399d8d204ef9881fac49834ccb3471

data/README.md

@@ -1,8 +1,7 @@
 # RailsTemplatedUrls
 
-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/rails_templated_urls`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem provides some helpers to build [templated URLS][1] based on the named
+routes of your Rails application.
 
 ## Installation
 
@@ -22,18 +21,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Assuming you have the following route on your `routes.rb` file:
+
+```ruby
+Rails.application.routes.draw do
+  resources :books
+end
+```
+
+You can use the following helpers on your views:
+
+```ruby
+templated_path :books # => "/books"
+templated_path :book # => "/books/{id}"
+templated_path :edit_book # => "/books/{id}/edit"
+templated_path :books, :foo, :bar # => "/books{?foo,bar}"
+```
+
+If you want the full URL, you can use another helper:
+
+```ruby
+templated_url :book # => "http://localhost:3000/books/{id}"
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/rails_templated_urls/fork )
+1. Fork it ( https://github.com/lenon/rails_templated_urls/fork )
 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
+
+[1]: http://tools.ietf.org/html/rfc6570
+[2]: http://devdocs.io/rails/abstractcontroller/helpers/classmethods#method-i-helper

data/lib/rails_templated_urls.rb

@@ -1,4 +1,9 @@
+require 'rails'
 require 'rails_templated_urls/version'
 require 'rails_templated_urls/errors'
 require 'rails_templated_urls/builder'
 require 'rails_templated_urls/view_helpers'
+
+ActiveSupport.on_load :action_view do
+  include RailsTemplatedUrls::ViewHelpers
+end

data/lib/rails_templated_urls/version.rb

@@ -1,3 +1,3 @@
 module RailsTemplatedUrls
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_templated_urls
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lenon Marcel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails