slds_on_rails 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 217ca23c820befbdb0c1f919bbd73575644d016a
+  data.tar.gz: a3a70548330289e1a39db9948d198234ff851191
+SHA512:
+  metadata.gz: d44a66e0ca3ea40f1005a196ced0302087dd785b576758c5e5c929eb8615836eb8e51645f21499c0a27889a7f8c14b9b4b54ddd37aede29139bbf676d868a43d
+  data.tar.gz: 4eb95d49d0d632cf26231e7b0c786acfe8cfbc1d1a34ba0cd136317743808e40b6ebdc8188859fe4cf75817cf1f1dbfd25183fb653869779f82e3aeaed83dad4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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,54 @@
+# Slds
+Short description and motivation.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slds'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install slds
+```
+
+## Setup
+
+1. Add to your helper:
+
+```ruby
+module ApplicationHelper
+  include Slds::Helper
+  slds_config version: '2.3.1', debug: false
+end
+```
+
+2. Add the link tag to your layout:
+
+```erb
+<%= slds_link_tag 'data-turbolinks-track': 'reload' %>
+```
+
+3. Now you can also load images and any other asset from slds:
+
+```erb
+# uses relative path: `/slds/images/spinners/slds_spinner.gif`
+<%= image_tag slds_asset_path('images/spinners/slds_spinner.gif') %>
+
+# uses absolute url: `https://unpkg.com/@salesforce-ux/design-system@2.3.1/assets/images/spinners/slds_spinner.gif'
+<%= image_tag slds_asset_url('images/spinners/slds_spinner.gif') %>
+```
+
+You can see all available assets on slds CDN at: https://unpkg.com/@salesforce-ux/design-system@2.3.1/assets/
+
+## Contributing
+Contribution directions go here.
+
+## 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,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Slds'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/slds/slds_controller.rb

@@ -0,0 +1,49 @@
+module Slds
+  class SldsController < ApplicationController
+    rescue_from StandardError, with: :render_error
+    layout false
+
+    def show
+      if slds_response.code == '200' # set our response headers
+        expires_in Slds.max_age, 's-maxage' => Slds.s_maxage, public: true
+        response.headers['Surrogate-Key'] = 'DFC-SLDS-ASSETS' # allow these to be expired from fastly as a group
+      elsif slds_response.code == '404'
+        slds_response.body = 'not found'
+      end
+
+      render(
+        body: slds_response.body,
+        content_type: slds_response.content_type,
+        status: slds_response.code
+      )
+    end
+
+    private
+
+    def slds_response
+      @slds_response ||= Net::HTTP.get_response(item_uri)
+    end
+
+    # Map the given URL path to the absolute url to the Slds asset uri (server).
+    #
+    # For example: Slds.assets_path('/icons/utility-sprite/svg/symbols.svg#right') =>
+    #   "/slds/2.2.1/assets/icons/utility-sprite/svg/symbols.svg#right"
+    #  which maps to this path in slds itself:
+    #     => 'https://unpkg.com/@salesforce-ux/design-system@2.2.1/assets/icons/utility-sprite/svg/symbols.svg#right"
+    def item_uri
+      path = params[:id] # eg "/icons/utility-sprite/svg/symbols.svg"
+      version = params[:version] # eg "2.2.1"
+      url = Slds.assets_url(path, version) # eg "https://unpkg.com/@salesforce-ux/design-system@#{version}/assets/icons/utility-sprite/svg/symbols.svg"
+      logger.debug("Slds::SldsController.item_uri: path #{path} proxied to #{url} using version #{version}") if Slds.debug
+
+      URI(url)
+    end
+
+    def render_error(e)
+      logger.error("Slds::SldsController.render_error: exception: #{e}")
+      e.backtrace.each { |line| logger.error line }
+
+      render(status: 500, body: 'error')
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Slds::Engine.routes.draw do
+  # This route removes the '/slds' prefix and sets version and path
+  # Example: '/slds/6.6.6/path_to_nowhere' => version='6.6.6' path = 'path_to_nowhere'
+  get ':version/*id' => 'slds#show', as: :slds, version: /[\d\.]+/, id: /\S+/
+end

data/lib/slds/engine.rb

@@ -0,0 +1,15 @@
+module Slds
+  class Engine < ::Rails::Engine
+    isolate_namespace Slds
+
+    initializer 'slds', before: :load_config_initializers do
+      Rails.application.routes.append do
+        mount Slds::Engine => '/slds'
+      end
+    end
+
+    initializer 'Rails logger', after: :load_config_initializers do
+      Slds.logger = Rails.logger # get 'updated' rails logger
+    end
+  end
+end

data/lib/slds/helper.rb

@@ -0,0 +1,24 @@
+module Slds::Helper
+  module SharedMethods
+    def slds
+      @@slds ||= Slds
+    end
+  end
+
+  extend ActiveSupport::Concern
+  include SharedMethods
+
+  class_methods do
+    include SharedMethods
+    delegate :config, to: :slds, prefix: true
+  end
+
+  delegate :assets_url, :assets_path, to: :slds, prefix: true
+
+  def slds_link_tag(options = {})
+    stylesheet_link_tag(
+      slds_assets_url('styles/salesforce-lightning-design-system.min.css'),
+      options
+    )
+  end
+end

data/lib/slds/version.rb

@@ -0,0 +1,3 @@
+module Slds
+  VERSION = '0.2.4'
+end

data/lib/slds.rb

@@ -0,0 +1,64 @@
+require 'slds/engine'
+require 'slds/helper'
+
+module Slds
+  extend self
+  attr_accessor :version
+  attr_accessor :url
+  attr_accessor :logger
+  attr_accessor :max_age
+  attr_accessor :s_maxage
+  attr_accessor :debug # for logging in the controller for each request
+
+  self.version = '2.2.1'
+  self.url = "https://unpkg.com/@salesforce-ux/design-system@VERSION/assets/"
+  self.max_age = 86400
+  self.s_maxage = 86400
+  self.debug = false
+
+  # Set the version and the url (dont mess with the url unless you know what you are doing)
+  # Usage: Slds.config { |slds| slds.version = '2.2.1'; slds.debug = true }
+  def config(options = {})
+    if options.present?
+      options.each { |key, value| send("#{key}=", value) }
+    else
+      yield self
+    end
+
+    validate_version(version)
+  end
+
+  # creates a absolute url that uses the url (unpkg.com) by prepending the url parameter.
+  # Note that /assets/ should not be part of your path.
+  # Slds.assets_url('styles/salesforce-lightning-design-system.min.css')
+  #   => 'https://unpkg.com/@salesforce-ux/design-system@2.2.1/assets/styles/salesforce-lightning-design-system.min.css'
+  def assets_url(path, v = version)
+    validate_version(v)
+    url.gsub('VERSION', v) + trim_path(path)
+  end
+
+  # creates a relative path for the slds asset that uses the version and starts with /slds
+  # For example: Slds.assets_path('/icons/utility-sprite/svg/symbols.svg')
+  #   creates this url => "/slds/2.2.1/icons/utility-sprite/svg/symbols.svg"
+  #
+  # This path can be put in your app and the Slds controller (of this gem) will handle the path
+  # (because it starts with /slds) and make a reverse proxy Net::http call to the url.
+  #
+  # The above url makes a http call to:
+  #   => 'https://unpkg.com/@salesforce-ux/design-system@2.2.1/assets/icons/utility-sprite/svg/symbols.svg"
+  def assets_path(path, v = version)
+    validate_version(v)
+    "/slds/#{v}/#{trim_path(path)}"
+  end
+
+  private
+
+  def validate_version(version)
+    raise ArgumentError.new("Slds: version #{version} not of the form 2.2.2 or 2.1 or 2 or 2.3.4.5 etc.") unless version =~ /^[0-9\.]+$/
+  end
+
+  # remove any leading / in the path (aka lchomp)
+  def trim_path(path)
+    path[0] == '/' ? trim_path(path[1..-1]) : path
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: slds_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- Marcelo Eden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.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: vcr
+  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: webmock
+  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: A rails wrapper for SLDS
+email:
+- edendroid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/slds/slds_controller.rb
+- config/routes.rb
+- lib/slds.rb
+- lib/slds/engine.rb
+- lib/slds/helper.rb
+- lib/slds/version.rb
+homepage: https://github.com/devforce/slds_on_rails
+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.6.8
+signing_key: 
+specification_version: 4
+summary: SLDS on Rails
+test_files: []