rails_js_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed02fdd14d945ce868164b67d43c7fdc0249475a
+  data.tar.gz: eae0ad1fad53ff7d9e6836cca95d73b06497c338
+SHA512:
+  metadata.gz: a0035c27a2adc4b8e83b5107c34d3512a34598293663de22470843d5503993c76d99ff0c8947fad275f85b429ec00acd3a6c5ce3f38c2300f1b07d2352c231cc
+  data.tar.gz: 7f523506f931890c30a4d0e1d18c9ae596278b758649b77b9b79be23b5d7f4fa3914779722e6c00e39d87aeb0f7938524cfa4e7464b3df98f39e072fe25bed1b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+/spec/dummy/tmp
+/spec/dummy/log
+/spec/dummy/public/assets

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2
+
+before_install: gem update bundler

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+source 'https://rails-assets.org' do
+  gem 'rails-assets-URIjs'
+end
+
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# RailsJsHelper
+[![Build Status](https://travis-ci.org/joker1007/rails_js_helper.svg)](https://travis-ci.org/joker1007/rails_js_helper)
+
+this gem define `RailsHelper` on JS.
+this gem embeds `image_path`, `asset_path` and routing table on compile timing on `rails_helper.js.coffee.erb.`
+
+`RailsHelper` has some functions.
+
+
+## Limitation
+this gem can use only no segments named routes.
+
+ex.
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  resources :users
+  end
+end
+```
+
+can use only `users`, `new_user`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_js_helper'
+```
+
+*Caution* this gem requires `rails-assets-URIjs`.
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```sh
+$ bundle exec rails g rails_js_helper:config
+
+# And edit config/rails_js_helper.yml
+```
+
+```yml
+images
+  - loading.png
+assets:
+  - loading.css
+configs:
+  google_api_key: <%= Rails.application.config.x.google_api_key %>
+```
+
+```coffee
+#= require rails_helper
+
+RailsHelper.image_path("loading.png") # => "/assets/loading.png"
+RailsHelper.image_tag("loading.png", width: 120) # => <img src="loading.png" width="120">
+RailsHelper.asset_path("users.css") # => /assets/users.css
+RailsHelper.named_route("users", format: "json", foo: "bar") # => "/users.json?foo=bar"
+RailsHelper.named_route("new_users") # => "/users/new"
+RailsHelper.route_names() # show all route names on javascript
+RailsHelper.config.google_api_key # => value of `Rails.application.config.x.google_api_key`
+```
+
+## 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.
+
+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/joker1007/rails_js_helper/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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/rails_helper.js.coffee.erb

@@ -0,0 +1,63 @@
+#= require URIjs/URI.js
+
+@RailsHelper = {
+  image_path_table: <%= RailsJsHelper.image_path_table.to_json %>
+
+  asset_path_table: <%= RailsJsHelper.asset_path_table.to_json %>
+
+  named_route_table: <%= RailsJsHelper.named_route_table.to_json %>
+
+  config: <%= RailsJsHelper.config_table.to_json %>
+
+  imagePath: (path) ->
+    RailsHelper.image_path_table[path]
+
+  assetPath: (path) ->
+    RailsHelper.asset_path_table[path]
+
+  imageTag: (path, attributes = {}) ->
+    src = RailsHelper.imagePath(path)
+    unless src
+      throw new Error("Asset path is nothing on table")
+    attrs = []
+    for k, v of attributes
+      attrs.push("#{k}=\"#{v}\"")
+    "<img src=\"#{src}\" #{attrs.join(" ")}>"
+
+  pathFor: (name, options = {}) ->
+    uri = RailsHelper._makeURI(name, options)
+    uri.toString()
+
+  urlFor: (name, options = {}) ->
+    protocol = "http"
+    host = location.host
+
+    if options.protocol
+      protocol = options.protocol
+      delete options.protocol
+
+    if options.host
+      host = options.host
+      delete options.host
+
+    uri = RailsHelper._makeURI(name, options)
+    uri.host(host)
+    uri.protocol(protocol)
+    uri.toString()
+
+  _makeURI: (name, options = {}) ->
+    base = RailsHelper.named_route_table[name]
+    unless base
+      throw new Error("Routing is nothing on table")
+    uri = new URI(base)
+    uri.suffix(options.format) if options.format?
+    delete options.format
+    uri.query(options)
+    uri
+
+  routeNames: ->
+    names = []
+    for name, _url of RailsHelper.named_route_table
+      names.push(name)
+    names
+}

data/bin/console

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

data/lib/rails/generators/rails_js_helper/config/config_generator.rb

@@ -0,0 +1,16 @@
+module RailsJsHelper
+  class ConfigGenerator < ::Rails::Generators::Base
+    # Copied files come from templates folder
+    source_root File.expand_path('../templates', __FILE__)
+
+    # Generator desc
+    desc <<-DESC
+        Creates a default rails_js_helper.yml configuration file in your app's config
+        folder.
+    DESC
+
+    def copy_initializer_file
+      copy_file "rails_js_helper.yml", "config/rails_js_helper.yml"
+    end
+  end
+end

data/lib/rails/generators/rails_js_helper/config/templates/rails_js_helper.yml

@@ -0,0 +1,6 @@
+images:
+  # - loading.png
+assets:
+  # - sortable.css
+configs:
+  # aws_api_key: "abcdefg"

data/lib/rails_js_helper.rb

@@ -0,0 +1,53 @@
+require "rails_js_helper/version"
+
+require 'active_support/configurable'
+
+module RailsJsHelper
+  class << self
+    def image_path_table
+      images = load_config["images"].to_a
+      Hash[
+        images.map do |path|
+          [path, ActionController::Base.helpers.image_path(path)]
+        end
+      ]
+    end
+
+    def asset_path_table
+      assets = load_config["assets"].to_a
+      Hash[
+        assets.map do |path|
+          [path, ActionController::Base.helpers.image_path(path)]
+        end
+      ]
+    end
+
+    def named_route_table
+      Rails.application.routes.named_routes
+        .select { |name, route| (route.parts - route.optional_parts).empty? }
+        .map {|name, route| [name, Rails.application.routes.url_helpers.send("#{name}_path")] }
+        .to_h
+    end
+
+    def config_table
+      load_config["configs"] || {}
+    end
+
+    private
+
+    def load_config
+      if config_file.exist?
+        YAML.load(ERB.new(config_file.read).result)
+      else
+        {}
+      end
+    end
+
+    def config_file
+      Rails.root.join("config", "rails_js_helper.yml")
+    end
+  end
+end
+
+require 'rails'
+require "rails_js_helper/engine"

data/lib/rails_js_helper/engine.rb

@@ -0,0 +1,13 @@
+module RailsJsHelper
+  class Engine < ::Rails::Engine
+    initializer "rails_js_helper-preprocessor", after: "sprockets.environment" do
+      Rails.application.assets.register_preprocessor "application/javascript", :"rails_js_helper-dependency" do |context, source|
+        if context.logical_path == "rails_helper"
+          context.depend_on(Rails.root.join("config", "rails_js_helper.yml").to_path)
+          context.depend_on(Rails.root.join("config", "routes.rb").to_path)
+        end
+        source
+      end
+    end
+  end
+end

data/lib/rails_js_helper/version.rb

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

data/rails_js_helper.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_js_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_js_helper"
+  spec.version       = RailsJsHelper::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Add Rails asset helper and named_route helper for JavaScript}
+  spec.description   = %q{Add Rails asset helper and named_route helper for JavaScript}
+  spec.homepage      = "https://github.com/joker1007/rails_js_helper"
+
+  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_runtime_dependency "rails", ">= 3.2"
+  spec.add_runtime_dependency "rails-assets-URIjs"
+  spec.add_runtime_dependency "coffee-rails", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "poltergeist"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: rails_js_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails-assets-URIjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 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: sqlite3
+  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: capybara
+  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: poltergeist
+  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: Add Rails asset helper and named_route helper for JavaScript
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascripts/rails_helper.js.coffee.erb
+- bin/console
+- bin/setup
+- lib/rails/generators/rails_js_helper/config/config_generator.rb
+- lib/rails/generators/rails_js_helper/config/templates/rails_js_helper.yml
+- lib/rails_js_helper.rb
+- lib/rails_js_helper/engine.rb
+- lib/rails_js_helper/version.rb
+- rails_js_helper.gemspec
+homepage: https://github.com/joker1007/rails_js_helper
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: Add Rails asset helper and named_route helper for JavaScript
+test_files: []