kuebiko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37dce4327fc9cd92773f19390c239fd0f80a72c4
+  data.tar.gz: ff6863c24f8d5ebbf1ac79e6ce1c9bfa59bf6b1f
+SHA512:
+  metadata.gz: 25aa443874b263a62809dbf9c3005258be1b7f54af5a78e1b8f638b39dc3f141b1c6505b50ccab5ea67b2ad5f70bc5ec5a8321d3bb3f40fcd808da95a11f35f0
+  data.tar.gz: b3df8d3c3a37aaab6db3ca5759ecebcfae1b6268e631b45179ee6d8fdd0d1016f54802eb4b4a59960a49a3ca4b42da38e2fee3c3376e65e2cd86a012e8eca1c3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+notifications:
+  emails:
+    - tsukasa.oishi@gmail.com
+before_install: gem install bundler -v 1.10.5

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails3" do
+  gem "activesupport", "~> 3.2.0"
+end
+
+appraise "rails40" do
+  gem "activesupport", "~> 4.0.0"
+end
+
+appraise "rails41" do
+  gem "activesupport", "~> 4.1.0"
+end
+
+appraise "rails42" do
+  gem "activesupport", "~> 4.2.0"
+end

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 tsukasaoishi
+
+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,193 @@
+# Kuebiko
+Kuebiko generates URLs from ruby code.
+
+[![Build Status](https://travis-ci.org/tsukasaoishi/kuebiko.svg?branch=master)](https://travis-ci.org/tsukasaoishi/kuebiko)
+[![Code Climate](https://codeclimate.com/github/tsukasaoishi/kuebiko/badges/gpa.svg)](https://codeclimate.com/github/tsukasaoishi/kuebiko)
+
+![Kuebiko](https://github.com/tsukasaoishi/kuebiko/wiki/images/kuebiko.jpg)
+
+## Usage
+URLs generator class inherits Kuebiko::Url.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  material :article
+  scheme :http
+  host "kaeruspoon.net"
+
+  def show
+    build "articles", article.title
+  end
+end
+```
+
+You can generate path or URL.
+```ruby
+article.title #=> "first_day"
+
+ArticleUrl.show_path(article) #=> "/articles/first_day"
+ArticleUrl.show_url(article) #=> "http://kaeruspoon.net/articles/first_day"
+
+url = ArticleUrl.new(article)
+url.show_path #=> "/articles/first_day"
+url.show_url #=> "http://kaeruspoon.net/articles/first_day"
+```
+Methods of suffix ```_path``` generate only path. 
+Methods of suffix ```_url``` generate URL.
+
+```show``` instance method is called from ```show_path``` method (or ```show_url```).
+
+### Resources that make up URL
+You can specify name of material. The material name will use as internal accessor name.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  material :article
+
+  def hoge
+    build article.title # article is the internal accessor
+  end
+end
+```
+
+You can pass the material object to the initializer or generator class methods.
+```ruby
+url = Article.new(article)
+Article.show_path(article)
+```
+The internal accessor returns nil if you do not pass the material object.
+
+You can specify more than one materials.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  material :article, :user
+end
+```
+The order in which you specify the materials will be the order of the objects to pass to the arguments.
+```ruby
+url = ArticleUrl.new(article, user)
+```
+
+The name ```options``` is reserved as internal accessor.
+
+### Components of URL
+You can specify default components.
+```ruby
+Kuebiko.default_components(
+  scheme: :https,
+  host: "kaeruspoon.net", 
+  port: 443
+)
+```
+The default value of each components are following when you do not specify value.
+* scheme ```:http```
+* host ```nil```
+* port ```nil```
+
+You can specify several options.
+```ruby
+Kuebiko.default_components(
+  host: "kaeruspoon.net",
+  trailing_slash: true
+)
+```
+Generating the URL with trailing slash if ```trailing_slash``` is true.
+
+You can specify these components and options in Kuebiko::Url class.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  scheme :http
+  host "kaeruspoon.net"
+  port 3000
+  trailing_slash true
+```
+The value in Kuebiko::Url class overrides the value of Kuebiko.default_components.
+
+You can specify these components and options at the build method.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  def show
+    build "articles", article.title, scheme: :https, host: "a.kaeruspoon.net", port: 1234, trailing_slash: true
+  end
+end
+```
+The value of build method overrides the value of Kuebiko::Url class.
+
+### Make up the URL
+The ```build``` method plays the central role to make up URLs.
+The first part of arguments would become the path of URL. The each arguments would be joined by slash.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  def show
+    build "articles", article.title
+  end
+end
+```
+```"articles"``` and ```article.title``` would be joined by slash. The result is "articles/first_day" (article.title is "first_day").
+The ```show_path``` method returns "/articles/first_day".
+
+The second part of argument is components and options (see avobe).
+There are following options in addition to ```trailing_slash```.
+
+```query``` is used to make up the query string.
+```ruby
+build "articles", article.title, query: {special_code: 123}
+ #=> "articles/first_day?special_code=123"
+```
+
+```anchor``` is used to add the anchor to the URL.
+```ruby
+build "articles", article.title, anchor: "top_navi"
+  #=> "articles/first_day#top_navi"
+```
+
+### options internal accessor
+There is ```options``` internal accessor.
+```ruby
+class ArticleUrl < Kuebiko::Url
+  material :article
+
+  def show
+    queries = options.select {|k,v| %i|code mode|.include?(k.to_sym) }
+    build "articles", article.title, query: queries
+  end
+end
+
+params = {controller: :articles, action: :index, code: "A", hoge: "B"}
+url = Article.new(article, params)
+url.show_path #=> "/articles/first_day?code=A"
+Article.show_path(article, params) #=> "/articles/first_day?code=A"
+```
+The arguments after materials arguments become ```options```.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kuebiko'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install kuebiko
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` 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/tsukasaoishi/kuebiko. 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.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kuebiko"
+
+# 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 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --path .bundle
+bundle exec appraisal install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec appraisal rake test

data/gemfiles/rails3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.2.0"
+
+gemspec :path => "../"

data/kuebiko.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kuebiko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kuebiko"
+  spec.version       = Kuebiko::VERSION
+  spec.authors       = ["tsukasaoishi"]
+  spec.email         = ["tsukasa.oishi@gmail.com"]
+
+  spec.summary       = %q{Kuebiko generates URLs from ruby code.}
+  spec.description   = %q{Kuebiko generates URLs from ruby code.}
+  spec.homepage      = "https://github.com/tsukasaoishi/kuebiko"
+  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_dependency "activesupport", ">= 3.2.0", "< 4.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'appraisal', '~> 2.0'
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+end

data/lib/generators/rails/templates/url.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Url < Kuebiko::Url
+end

data/lib/generators/rails/url_generator.rb

@@ -0,0 +1,11 @@
+module Rails
+  module Generators
+    class UrlGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_decorator_file
+        template 'url.rb', File.join('app/urls', class_path, "#{file_name}_url.rb")
+      end
+    end
+  end
+end

data/lib/kuebiko.rb

@@ -0,0 +1,9 @@
+require "kuebiko/version"
+require "kuebiko/url"
+require "kuebiko/railtie" if defined?(Rails)
+
+module Kuebiko
+  def self.default_components(options = {})
+    Url.default_components(options)
+  end
+end

data/lib/kuebiko/preparation.rb

@@ -0,0 +1,27 @@
+require 'cgi'
+require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/object/blank"
+
+module Kuebiko
+  class Preparation
+    attr_reader :scheme, :host, :port
+
+    def initialize(paths, options)
+      @paths = paths
+      @query = options[:query]
+      @anchor = options[:anchor]
+      @trailing_slash = options[:trailing_slash]
+      @scheme = options[:scheme]
+      @host = options[:host]
+      @port = options[:port]
+    end
+
+    def build
+      path = @paths.select{|item| item.present?}.map{|item| CGI.escape(item.to_s)}.join('/')
+      path << "/" if path.present? && @trailing_slash
+      path << "?#{@query.to_query}" if @query.present?
+      path << "##{CGI.escape(@anchor.to_s)}" if @anchor.present?
+      path
+    end
+  end
+end

data/lib/kuebiko/railtie.rb

@@ -0,0 +1,7 @@
+module Kuebiko
+  class Railtie < Rails::Railtie
+    initializer "kuebiko.autoload", before: :set_autoload_paths do |app|
+      app.config.autoload_paths << "#{app.config.root}/app/urls"
+    end
+  end
+end

data/lib/kuebiko/url.rb

@@ -0,0 +1,49 @@
+require "kuebiko/url/components"
+require "kuebiko/url/material"
+require "kuebiko/preparation"
+
+module Kuebiko
+  class Url
+    def self.method_added(name)
+      return unless public_method_defined?(name)
+      return if /_(path|url)\z/ === name
+
+      class_eval <<-DEF_URL_METHOD, __FILE__, __LINE__ + 1
+        class << self
+          def #{name}_path(*args, **options)
+            new(*args, **options).#{name}_path
+          end
+
+          def #{name}_url(*args, **options)
+            new(*args, **options).#{name}_url
+          end
+        end
+
+        def #{name}_path(options = {})
+          "/" + #{name}.build
+        end
+
+        def #{name}_url(options = {})
+          url = my_scheme.to_s + "://" + my_host.to_s
+          url << (":" + my_port.to_s) if my_port
+          url + "/" + #{name}.build
+        end
+      DEF_URL_METHOD
+    end
+
+    def initialize(*_, **options)
+      @_options = options
+    end
+
+    private
+
+    def build(*paths, **options)
+      options[:trailing_slash] ||= my_trailing_slash
+      Preparation.new(paths, options)
+    end
+
+    def options
+      @_options
+    end
+  end
+end

data/lib/kuebiko/url/components.rb

@@ -0,0 +1,44 @@
+module Kuebiko
+  class Url
+    DEFAULT = {scheme: :http}
+    COMPONENTS = %i|scheme host port trailing_slash|
+    private_constant :DEFAULT, :COMPONENTS
+
+    @@components = {}
+
+    class << self
+      def default_components(options = {})
+        options.each do |comp, value|
+          raise ArgumentError, "unknown components #{comp.inspect}" unless COMPONENTS.include?(comp)
+          instance_eval "#{comp}(value)"
+        end
+      end
+    end
+
+
+    COMPONENTS.each do |config|
+      class_eval <<-DEF_COMP, __FILE__, __LINE__ + 1
+        class << self
+          def #{config}(value)
+            @@components[self] ||= {}
+            @@components[self][:#{config}] = value
+          end
+        end
+
+        def my_#{config}(klass = self.class)
+          return options[:#{config}] if options.key?(:#{config})
+
+          my_components = (@@components[klass] ||= {})
+          if my_components.key?(:#{config})
+            my_components[:#{config}]
+          elsif klass == ::Kuebiko::Url
+            DEFAULT[:#{config}]
+          else
+            my_#{config}(self.class.superclass)
+          end
+        end
+        private :my_#{config}
+      DEF_COMP
+    end
+  end
+end

data/lib/kuebiko/url/material.rb

@@ -0,0 +1,18 @@
+module Kuebiko
+  class Url
+    class << self
+      def material(*names)
+        class_eval <<-DEF_INIT, __FILE__, __LINE__ + 1
+          def initialize(*materials, **options)
+            #{names.map{|n| "@_#{n}"}.join(", ")}, _dust = materials
+            @_options = options
+          end
+
+          #{names.map{|n| "def #{n}; @_#{n}; end"}.join("\n")}
+          private #{names.map{|n| ":#{n}"}.join(", ")}
+        DEF_INIT
+      end
+    end
+  end
+end
+

data/lib/kuebiko/version.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: kuebiko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tsukasaoishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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: Kuebiko generates URLs from ruby code.
+email:
+- tsukasa.oishi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- gemfiles/rails3.gemfile
+- gemfiles/rails40.gemfile
+- gemfiles/rails41.gemfile
+- gemfiles/rails42.gemfile
+- kuebiko.gemspec
+- lib/generators/rails/templates/url.rb
+- lib/generators/rails/url_generator.rb
+- lib/kuebiko.rb
+- lib/kuebiko/preparation.rb
+- lib/kuebiko/railtie.rb
+- lib/kuebiko/url.rb
+- lib/kuebiko/url/components.rb
+- lib/kuebiko/url/material.rb
+- lib/kuebiko/version.rb
+homepage: https://github.com/tsukasaoishi/kuebiko
+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.8
+signing_key: 
+specification_version: 4
+summary: Kuebiko generates URLs from ruby code.
+test_files: []