dragoman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 127dbccea787a7238a460c76d61ee6b0fcc90c9f
+  data.tar.gz: 0e75c1d8df90190e98f30f88364ea39d42e47803
+SHA512:
+  metadata.gz: 4f23021dd1c0377525fb59ef808df8ba0ad8e958eab803231c7c0fc8b14f082dcfdca8ed21d92783557d1d4aae4d53f6d5ca9c9b6b9858362038de2484bb774e
+  data.tar.gz: 6a6507b47d6dfde740485eebdf91085c36209c8c237d2abe67ae3283d6801dac83ac9f8fd6e532eff5a7ad3f74ee6a996f68d83befdcf689b20c3098b69440c3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Appraisals

@@ -0,0 +1,17 @@
+appraise "rails-3.2" do
+  gem "rails", "~> 3.2.0"
+end
+
+
+appraise "rails-4.2" do
+  gem "rails", "~> 4.2.0"
+end
+
+# DOES NOT WORK FOR 4.0 en 4.1
+# appraise "rails-4.0" do
+#   gem "rails", "~> 4.0.0"
+# end
+
+# appraise "rails-4.1" do
+#   gem "rails", "~> 4.1.0"
+# end

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appraisal'
+
+gemspec

data/Guardfile

@@ -0,0 +1,79 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(%r(^spec/.*spec_helper\.rb$)) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  watch(%r(^spec/fixtures/)) { rspec.spec_dir}
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+  watch(%r(^lib/.*\.rb$)) { rspec.spec_dir}
+
+  # Rails files
+  # rails = dsl.rails(view_extensions: %w(erb haml slim))
+  # dsl.watch_spec_files_for(rails.app_files)
+  # dsl.watch_spec_files_for(rails.views)
+
+  # watch(rails.controllers) do |m|
+  #   [
+  #     rspec.spec.("routing/#{m[1]}_routing"),
+  #     rspec.spec.("controllers/#{m[1]}_controller"),
+  #     rspec.spec.("acceptance/#{m[1]}")
+  #   ]
+  # end
+
+  # Rails config changes
+  # watch(rails.spec_helper)     { rspec.spec_dir }
+  # watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  # watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # # Capybara features specs
+  # watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # # Turnip features and steps
+  # watch(%r{^spec/acceptance/(.+)\.feature$})
+  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+  #   Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  # end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pieter Visser
+
+MIT License
+
+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,29 @@
+# Dragoman
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dragoman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dragoman
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dragoman/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dragoman.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dragoman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dragoman"
+  spec.version       = Dragoman::VERSION
+  spec.authors       = ["Pieter Visser", "Robert Jan de Gelder"]
+  spec.email         = ["info@greenonline.nl"]
+  spec.summary       = %q{Simple Rails Routes Translator}
+  spec.homepage      = "http://github.com/pietervisser/dragoman"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("rspec-rails")
+  spec.add_development_dependency("guard-rspec")
+end

data/gemfiles/rails_3.2.gemfile

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

data/gemfiles/rails_4.2.gemfile

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

data/lib/dragoman/mapper.rb

@@ -0,0 +1,56 @@
+module Dragoman
+  module Mapper
+
+    module Mapping
+      def build_with_localization scope, set, path, as, options
+        if options[:locale]
+          Dragoman::UrlHelpers.add_untranslated_helpers as, set.named_routes.path_helpers_module, set.named_routes.url_helpers_module if as
+          as = "#{as}_#{options[:locale]}" if as.present?
+          as = nil if as && set.named_routes.routes[as.to_sym] # TODO: why do we need to set as to nil?
+        end
+        build_without_localization scope, set, path, as, options
+      end
+    end
+
+    private
+
+    def localize
+      @current_locale = nil
+      locales = I18n.available_locales
+      locales.each do |locale|
+        @current_locale = locale
+        yield
+      end
+      @current_locale = nil
+    end
+
+    def add_route_with_localization(action, options)
+      if @current_locale
+        options[:path] = Dragoman::Translator.translate_path(action, @current_locale) unless canonical_action?(action)
+        options[:locale] = @current_locale
+      end
+      add_route_without_localization action, options
+    end
+
+    def scope_with_localization(*args, &block)
+      if @current_locale
+        options = args.extract_options!.dup
+        if options[:path] || args.any?
+          options[:path] = Dragoman::Translator.translate_path(options[:path] || args.flatten.join('/'), @current_locale)
+        end
+        scope_without_localization options, &block
+      else
+        scope_without_localization *args, &block
+      end
+    end
+
+    def resources_with_localization(*resources, &block)
+      options = resources.extract_options!.dup
+      if @current_locale
+        options[:path] = Dragoman::Translator.translate_path(resources.last, @current_locale)
+      end
+      resources_without_localization(*resources, options, &block)
+    end
+
+  end
+end

data/lib/dragoman/mapper_rails3.rb

@@ -0,0 +1,39 @@
+module Dragoman
+
+  module MapperRails3
+    include Mapper
+
+    def self.included(base)
+      base.send :alias_method_chain, :add_route, :localization
+      base.send :alias_method_chain, :scope, :localization
+
+      base.send :alias_method_chain, :resources, :localization
+
+      base::Mapping.send :include,  MappingRails3
+    end
+
+    module MappingRails3
+      def self.included(base)
+        base.send :alias_method_chain, :to_route, :localization
+      end
+
+      def to_route_with_localization
+        if @options[:locale]
+          Dragoman::UrlHelpers.add_untranslated_helpers @options[:as], @set.named_routes.module, @set.named_routes.module if @options[:as]
+          @options[:as] = "#{@options[:as]}_#{@options[:locale]}" if @options[:as].present?
+          @options[:as] = nil if @options[:as] && @set.named_routes.routes[@options[:as].to_sym] # TODO: why do we need to set as to nil?
+        end
+        to_route_without_localization
+      end
+    end
+
+    def add_route_with_localization(action, options)
+      if @current_locale
+        options[:path] = Dragoman::Translator.translate_path(action, @current_locale) unless canonical_action?(action, true)
+        options[:locale] = @current_locale
+      end
+      add_route_without_localization action, options
+    end
+
+  end
+end

data/lib/dragoman/mapper_rails4.rb

@@ -0,0 +1,21 @@
+module Dragoman
+  module MapperRails4
+
+    include Mapper
+
+    def self.included(base)
+      base.send :alias_method_chain, :add_route, :localization
+      base.send :alias_method_chain, :scope, :localization
+
+      base.send :alias_method_chain, :resources, :localization
+
+      base::Mapping.extend Mapping
+      base::Mapping.class_eval do
+        class << self
+          alias_method_chain :build, :localization
+        end
+      end
+    end
+
+  end
+end

data/lib/dragoman/railtie.rb

@@ -0,0 +1,13 @@
+module Dragoman
+
+  class Railtie < Rails::Railtie
+    initializer 'dragoman.insert_into_routing_mapper' do |app|
+      if Rails::VERSION::MAJOR >= 4
+        ActionDispatch::Routing::Mapper.send :include, Dragoman::MapperRails4
+      else
+        ActionDispatch::Routing::Mapper.send :include, Dragoman::MapperRails3
+      end
+    end
+  end
+
+end

data/lib/dragoman/translation_visitor.rb

@@ -0,0 +1,14 @@
+module Dragoman
+  class TranslationVisitor < Dragoman::Journey::Visitors::String
+
+    def initialize locale
+      @locale = locale
+      super()
+    end
+
+    def visit_LITERAL node
+      I18n.t node, scope: :routes, default: node.to_s, locale: @locale
+    end
+
+  end
+end

data/lib/dragoman/translator.rb

@@ -0,0 +1,12 @@
+module Dragoman
+
+  class Translator
+
+    def self.translate_path path, locale
+      parsed_path = Dragoman::Journey::Parser.new.parse(path.to_s)
+      Dragoman::TranslationVisitor.new(locale).accept(parsed_path)
+    end
+
+  end
+
+end

data/lib/dragoman/url_helpers.rb

@@ -0,0 +1,19 @@
+module Dragoman
+  class UrlHelpers
+
+    def self.add_untranslated_helpers name, path_module, url_module
+      path_module.send :define_method, "#{name}_path" do |*args|
+        __send__(Dragoman::UrlHelpers.localized_helper_name(name, :path), *args)
+      end
+      url_module.send :define_method, "#{name}_url" do |*args|
+        __send__(Dragoman::UrlHelpers.localized_helper_name(name, :url), *args)
+      end
+    end
+
+    def self.localized_helper_name name, url_helper_type
+      locale = I18n.locale
+      "#{name}_#{locale}_#{url_helper_type}"
+    end
+
+  end
+end

data/lib/dragoman/version.rb

@@ -0,0 +1,3 @@
+module Dragoman
+  VERSION = "0.0.1"
+end

data/lib/dragoman.rb

@@ -0,0 +1,21 @@
+module Dragoman
+  Journey = if Rails::VERSION::MAJOR >= 4
+    ActionDispatch::Journey
+  else
+    require 'journey'
+    Journey
+  end
+end
+
+require "dragoman/translator"
+require "dragoman/translation_visitor"
+require "dragoman/url_helpers"
+require "dragoman/mapper"
+require "dragoman/railtie" if defined?(Rails)
+require "dragoman/version"
+
+if Rails::VERSION::MAJOR >= 4
+  require "dragoman/mapper_rails4"
+else
+  require "dragoman/mapper_rails3"
+end

data/spec/dragoman_spec.rb

@@ -0,0 +1,12 @@
+require 'minimal_spec_helper'
+
+describe Dragoman do
+  it 'is a module' do
+    expect(Dragoman).to be_a(Module)
+  end
+
+  it 'is loadable without preloading rails' do
+    expect { require 'dragoman' }.not_to raise_error
+  end
+
+end

data/spec/fake_app.rb

@@ -0,0 +1,26 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end
+
+module Dummy
+
+  def self.rails4?
+    Rails::VERSION::MAJOR >= 4
+  end
+
+  class Application < Rails::Application
+    config.secret_key_base = "test"
+    config.paths["public"] = ["spec/fixtures/public"]
+    config.paths["config/locales"] = ["spec/fixtures/locales/routes.yml"]
+    config.eager_load = false
+
+    if Dummy.rails4?
+      config.paths["config/routes.rb"] = ["spec/fixtures/config/routes.rb"]
+    else
+      config.paths["config/routes"] = ["spec/fixtures/config/routes.rb"]
+    end
+
+  end
+end
+
+Dummy::Application.initialize!

data/spec/fixtures/config/routes.rb

@@ -0,0 +1,17 @@
+Dummy::Application.routes.draw do
+  get 'comments' => 'application#index'
+
+  localize do
+    namespace 'admin' do
+      get 'customers' => 'application#index'
+    end
+
+    scope 'secret' do
+      get 'payments' => 'application#index'
+    end
+
+    resources :products
+    resource :account
+  end
+
+end

data/spec/fixtures/locales/routes.yml

@@ -0,0 +1,13 @@
+en:
+  routes:
+nl:
+  routes:
+    admin: beheer
+    secret: geheim
+    customers: klanten
+    payments: betalingen
+    products: producten
+    new: nieuw
+    edit: wijzigen
+    account: profiel
+

data/spec/minimal_spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+end

data/spec/routing/routes_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+class ProductsController < ApplicationController
+end
+
+describe 'routes' do
+
+  context "unlocalized routes" do
+    it 'does not change routes' do
+      expect(comments_path).to eq '/comments'
+      expect(Rails.application.routes.url_helpers.respond_to? :comments_nl_path).to eq false
+    end
+  end
+
+  it 'translates resources' do
+    expect(products_en_path).to eq '/products'
+    expect(new_product_en_path).to eq '/products/new'
+    expect(edit_product_en_path(1)).to eq '/products/1/edit'
+    expect(products_nl_path).to eq '/producten'
+    expect(new_product_nl_path).to eq '/producten/nieuw'
+    expect(edit_product_nl_path(1)).to eq '/producten/1/wijzigen'
+  end
+
+  it 'translates resource' do
+    expect(account_en_path).to eq '/account'
+    expect(edit_account_en_path).to eq '/account/edit'
+    expect(new_account_en_path).to eq '/account/new'
+    expect(account_nl_path).to eq '/profiel'
+    expect(edit_account_nl_path).to eq '/profiel/wijzigen'
+    expect(new_account_nl_path).to eq '/profiel/nieuw'
+  end
+
+  it 'translates namespaced routes' do
+    expect(admin_customers_nl_path).to eq '/beheer/klanten'
+    expect(admin_customers_en_path).to eq '/admin/customers'
+  end
+
+  it 'translates scoped routes' do
+    expect(payments_nl_path).to eq '/geheim/betalingen'
+    expect(payments_en_path).to eq '/secret/payments'
+  end
+
+  it 'sets the correct locale' do
+    assert_routing '/producten', :controller => 'products', :action => 'index', :locale => :nl
+    assert_routing '/products', :controller => 'products', :action => 'index', :locale => :en
+  end
+
+  describe 'adds untranslated path helpers' do
+    it 'uses the I18n locale' do
+      I18n.locale = :nl
+      expect(payments_path).to eq '/geheim/betalingen'
+    end
+  end
+
+  describe 'adds untranslated url helpers' do
+    it 'uses the I18n locale' do
+      print_routes
+      I18n.locale = :nl
+      expect(payments_url).to eq 'http://example.com/geheim/betalingen'
+    end
+  end
+
+end
+
+def print_routes
+  all_routes = Rails.application.routes.routes
+  if Rails::VERSION::MAJOR >= 4
+    require 'action_dispatch/routing/inspector'
+    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+    puts '', inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER'])
+  else
+    require 'rails/application/route_inspector'
+    inspector = Rails::Application::RouteInspector.new
+    puts inspector.format(all_routes, ENV['CONTROLLER']).join "\n"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+ENV["RAILS_ENV"] = "test"
+
+# require 'rails/all'
+
+require "action_controller/railtie"
+require 'action_view/railtie'
+require 'action_dispatch/railtie'
+require 'rspec/rails'
+
+require "dragoman"
+require 'fake_app'
+
+Rails.application.routes.default_url_options[:host] = 'example.com'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+RSpec.configure do |config|
+
+  config.infer_spec_type_from_file_location!
+
+  config.after(:each) do
+    I18n.locale = I18n.default_locale = :en
+    # Rails.application.reload_routes!
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: dragoman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pieter Visser
+- Robert Jan de Gelder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: guard-rspec
+  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: 
+email:
+- info@greenonline.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Appraisals
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dragoman.gemspec
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.2.gemfile
+- lib/dragoman.rb
+- lib/dragoman/mapper.rb
+- lib/dragoman/mapper_rails3.rb
+- lib/dragoman/mapper_rails4.rb
+- lib/dragoman/railtie.rb
+- lib/dragoman/translation_visitor.rb
+- lib/dragoman/translator.rb
+- lib/dragoman/url_helpers.rb
+- lib/dragoman/version.rb
+- spec/dragoman_spec.rb
+- spec/fake_app.rb
+- spec/fixtures/config/routes.rb
+- spec/fixtures/locales/routes.yml
+- spec/minimal_spec_helper.rb
+- spec/routing/routes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pietervisser/dragoman
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple Rails Routes Translator
+test_files:
+- spec/dragoman_spec.rb
+- spec/fake_app.rb
+- spec/fixtures/config/routes.rb
+- spec/fixtures/locales/routes.yml
+- spec/minimal_spec_helper.rb
+- spec/routing/routes_spec.rb
+- spec/spec_helper.rb