path-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 254df16154ad72a0d5889fef16dffd7e8c509c13
+  data.tar.gz: 429d1556c9ec898a2d75d3117241d480afed7e33
+SHA512:
+  metadata.gz: e6f09f8b3027c314da981528576a8f277eb9e453fba6d0e424e9b9b4d511aa2a49c0a4e4e93b2615ee118cedca47f45f20205780cc26a1a4af2aa238815aded6
+  data.tar.gz: c04c667be7062c7ca1c921c1dddd0de91bf52e0ec86c0566607b8072be3bec320037af221263d3c93792b718bd93947876229a0b51a6707abca8a4ad7329dbc4

data/.gitignore

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

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 ben@bensites.com. 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 path-builder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben
+
+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,117 @@
+# PathBuilder
+
+A friendly syntax for writing url-like paths in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'path-builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install path-builder
+
+## Usage
+
+Require the gem:
+
+```ruby
+require 'path-builder'
+```
+
+Make a path:
+```ruby
+path = PathBuilder.new
+path.api.moo.to_s #=> 'api/moo/'
+```
+
+Add a variable path segment:
+```ruby
+path = PathBuilder.new
+path.api.(:version).moo.to_s('v1') #=> 'api/v1/moo/'
+```
+
+Or use `#[]` instead of `#to_s`:
+```ruby
+path = PathBuilder.new
+path.api.(:version).moo['v1'] #=> 'api/v1/moo/'
+```
+
+Why is that dot there? Because Ruby. Can we remove the dot? Yes, because Ruby:
+```ruby
+path = PathBuilder.new
+path.api(:version).moo['v1'] #=> 'api/v1/moo/'
+```
+
+Use it out of the box:
+```ruby
+PathBuilder.new.api(:version).moo['v1'] #=> 'api/v1/moo/'
+```
+
+Put in a url:
+```ruby
+path = PathBuilder.new
+path[] = 'http://example.com'
+path.api(:version).moo.to_s #=> 'http://example.com/api/v1/moo'
+```
+
+Reuse it:
+```ruby
+ApiPath = PathBuilder.new.path.api(:version).save!
+ApiPath.new.moo['v1'] #=> 'api/v1/moo'
+```
+
+Reuse even more:
+```ruby
+ApiPath = ApiPath['v1']
+ApiPath.new.moo.to_s #=> 'api/v1/moo'
+```
+
+`break_on_empty` may help you REST...
+```ruby
+UsersPath = ApiPath.users(:user_id).save!
+
+UsersPath.new.to_s #=> 'api/v1/users/user_id/'
+UsersPath.new.to_s(break_on_empty: true) #=> 'api/v1/users/'
+UsersPath.new.to_s(1, break_on_empty: true) #=> 'api/v1/users/1'
+
+# Or just:
+
+UsersPath.break_on_empty = true # PROTIP: You can set PathBuilder#break_on_empty in a config file.
+
+UsersPath.new[] #=> 'api/v1/users/'
+UsersPath.new[nil] #=> 'api/v1/users/'
+UsersPath.new['1'] #=> 'api/v1/users/1'
+UsersPath.new.comments[] #=> 'api/v1/users'
+UsersPath.new.comments['1'] #=> 'api/v1/users/1/comments/'
+UsersPath.new.comments(:comment_id).post['1'] #=> 'api/v1/users/1/comments/'
+UsersPath.new.comments(:comment_id).post['1', '2'] #=> 'api/v1/users/1/comments/2/post'
+```
+
+Curious on how it works? Read the 88 line [source].
+
+Have fun.
+
+## 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]/path-builder. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[source]: lib/path-builder.rb

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 "path/builder"
+
+# 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/path-builder.rb

@@ -0,0 +1,87 @@
+class PathBuilder
+  def initialize
+    @path = self.class.base_path.dup
+  end
+
+  class <<self
+    def base_path=(path)
+      @base_path = path
+    end
+    def base_path
+      @base_path ||= []
+    end
+    def [](*args)
+      if @base_args
+        @base_args += args
+      else
+        @base_args = args
+      end
+      self
+    end
+    def base_args=(v)
+      @base_args = v
+    end
+    def base_args
+      @base_args ||= []
+    end
+    def break_on_empty
+      @break_on_empty
+    end
+    def break_on_empty=(v)
+      @break_on_empty = v
+    end
+  end
+
+  # Add a segment (string)
+  def method_missing(segment, *args)
+    @path << segment.to_s
+    @path += args.map{ |a| a.to_sym }
+    self
+  end
+
+  # Add a variable segment (symbol)
+  def call(segment)
+    @path << segment.to_sym
+    self
+  end
+
+  # Add a segment (string)
+  def []=(*args)
+    if args.length = 1
+      segment = *args
+      @path << segment.to_s if segment
+    else
+      variable_segment, *segment = *args
+      @path << variable_segment.to_sym if variable_segment
+      @path += segment.map(&:to_s)
+    end
+    self
+  end
+
+  def [](*args, break_on_empty: self.class.break_on_empty)
+    args += self.class.base_args.dup
+    @path.map do |segment|
+      if segment.is_a? Symbol
+        args.shift || (break_on_empty ? nil : segment)
+      else
+        segment
+      end
+    end.take_while{|i|i}.join('/') << '/'
+  end
+  alias :to_s :[]
+
+  def -(number)
+    @path.pop number
+  end
+
+  def save!(break_on_empty: self.class.break_on_empty)
+    klass = Class.new self.class
+    klass.base_path = @path
+    klass.break_on_empty = break_on_empty
+    klass
+  end
+
+  def inspect
+    "#<#{self.class.name} /#{@path.map(&:inspect).join('/')}>"
+  end
+end

data/lib/path-builder/version.rb

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

data/path-builder.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'path-builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "path-builder"
+  spec.version       = PathBuilder::VERSION
+  spec.authors       = ["Ben"]
+  spec.email         = ["ben@bensites.com"]
+
+  spec.summary       = %q{A simple syntax for building url-like paths}
+  spec.description   = %q{Paths, but more Rubyish.}
+  spec.homepage      = "https://github.com/penne12/path-builder"
+  spec.license       = "MIT"
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: path-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Paths, but more Rubyish.
+email:
+- ben@bensites.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/path-builder.rb
+- lib/path-builder/version.rb
+- path-builder.gemspec
+homepage: https://github.com/penne12/path-builder
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple syntax for building url-like paths
+test_files: []