front_man 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9768629ff7e4c4e6de7c5f396a584b3f4233e95d
-  data.tar.gz: 3f4431ab526b6f67108323aece0e855d2c7593e0
+  metadata.gz: a10787fabe7a96368a32944056daadb118c1b33f
+  data.tar.gz: 0ed139a951bb8a553b2400cf9b0cdfc84180bab9
 SHA512:
-  metadata.gz: 050d99748bb14ceea7d41e625102fe15671900c5a58491caad8910c4c79beee3b3d531c576eda78307efc66a80613c373361e7539be8117711d63b09877d8248
-  data.tar.gz: c90e2087264591af64dcb77e11c4fb73ebc86cc16bcbbb7e38dea3bcee0da244b1269f9781becfa6e43b8556ad7ad6c62c4359ed002c64652e58aae695303691
+  metadata.gz: f6c95800f8a0cb67927e54d1bead625ecf2e404b57b4b5b6135de775f1f8a3a3fcbcbdb0f88ac33af38f55cbbe0c9004b88188a9430c512e96a17afef3f323d7
+  data.tar.gz: 2d211696e64cfe6077b3f66d77de38a8a75d5207336498853735e1e7a61617e22922b19d04456200264f22d83b9d52db78a86545d7936854cbe2ef278327b94c

data/README.md

@@ -16,6 +16,14 @@ And then execute:
 $ bundle
 ```
 
+### Middleman
+
+If you're using middleman, add this line to `config.rb`:
+
+```ruby
+activate :front_man
+```
+
 ## Usage
 
 Import front_man in your `application.scss`:
@@ -30,15 +38,68 @@ Or if you want to import components manually:
 @import 'front_man/z-index';
 ```
 
-Make sure the file has .scss extension (or .sass for Sass syntax). If you have just generated a new Rails app, it may come with a .css file instead. If this file exists, it will be served instead of Sass, so rename it:
+Make sure the `application.scss` file has .scss extension (or .sass for Sass syntax). If you
+have just generated a new Rails app, it may come with a .css file instead. If this file
+exists, it will be served instead of Sass, so rename it:
 
 ```bash
 $ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss
 ```
 
+### Helper methods
+
+The front_man gem includes several helper methods.
+
+#### inline_svg(filename)
+
+Renders svg file in a hidden div for later referencing of it's elements; usually used to load
+a single svg file that consists of all svg files concatenated together.
+
+Example (you can put this at the bottom of your layout (`application.html.erb`) file:
+
+```ruby
+<%= inline_svg('icons.svg') %>
+```
+
+#### sprite_tag(filename, options = {})
+
+Works together with `inline_svg` to serve specific svg file from concatenated file.
+
+Example:
+
+```ruby
+<%= sprite_tag('icon-home', class: 'svgIcon svgIcon-40') %>
+```
+
+You can use css classes to style the icon:
+
+```scss
+.svgIcon-40 {
+  width: 40px;
+  height: 40px;
+  fill: $base-color; // use fill instead of color
+}
+```
+
+All the options passed to sprite_tag are passed on to svg content_tag.
+
+#### image_set\_tag(filename, options = {})
+
+Used to set `srcset` attribute on `img` tag.
+
+Example:
+
+```ruby
+image_set_tag(item.image.medium, srcset: {
+  item.image.thumb    => '200w',
+  item.image.medium   => '600w',
+  item.image.large    => '800w'
+})
+```
+
 ## Kudos
 
-The conventions laid out here were based upon those discussed in the article below. Kudos to [@fat](https://github.com/fat).
+The conventions laid out in the asset files here were based upon those discussed in the article below. Kudos to [@fat](https://github.com/fat).
 
 https://medium.com/@fat/mediums-css-is-actually-pretty-fucking-good-b8e2a6c78b06
 

data/app/helpers/front_man/images_helper.rb

@@ -7,8 +7,16 @@ module FrontMan
     end
 
     def inline_svg(filename)
-      file = File.read("app/assets/images/#{filename}")
-      content_tag :div, file.html_safe, class: 'u-is-hidden'
+      case FrontMan.framework
+      when :rails
+        file_path = "app/assets/images/#{filename}"
+      when :middleman
+        file_path = sitemap.find_resource_by_path(image_path('icons.svg'))
+          .source_file
+      end
+
+      file_contents = File.read(file_path)
+      content_tag :div, file_contents.html_safe, class: 'u-is-hidden'
     end
 
     def image_set_tag(filename, options = {})

data/front_man.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'

data/lib/front_man/core_ext/middleman.rb

@@ -0,0 +1,13 @@
+require_relative '../../../app/helpers/front_man/images_helper'
+
+module FrontMan
+  class MiddlemanExtension < Middleman::Extension
+    helpers do
+      include FrontMan::ImagesHelper
+    end
+  end
+
+  FrontMan.framework = :middleman
+end
+
+::Middleman::Extensions.register(:front_man, FrontMan::MiddlemanExtension)

data/lib/front_man/core_ext/railtie.rb

@@ -0,0 +1,8 @@
+require 'rails/engine'
+
+module FrontMan
+  class Engine < ::Rails::Engine
+  end
+
+  FrontMan.framework = :rails
+end

data/lib/front_man/version.rb

@@ -1,3 +1,3 @@
 module FrontMan
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/front_man.rb

@@ -1,7 +1,13 @@
-require 'front_man/engine'
+require 'active_support'
 
 module FrontMan
+  mattr_accessor :framework
+
   def self.root
     Pathname.new(File.dirname(__dir__))
   end
 end
+
+extension   = :railtie if defined?(Rails)
+extension ||= :middleman if defined?(Middleman)
+require "front_man/core_ext/#{extension}" if extension

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: front_man
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Viktor Fonic
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +165,8 @@ files:
 - bin/setup
 - front_man.gemspec
 - lib/front_man.rb
-- lib/front_man/engine.rb
+- lib/front_man/core_ext/middleman.rb
+- lib/front_man/core_ext/railtie.rb
 - lib/front_man/version.rb
 homepage: http://dvelp.co.uk/
 licenses:
@@ -178,4 +193,3 @@ signing_key:
 specification_version: 4
 summary: The DVELP frontend framework.
 test_files: []
-has_rdoc: 

data/lib/front_man/engine.rb

@@ -1,11 +0,0 @@
-require 'rails/engine'
-
-module FrontMan
-  class Engine < ::Rails::Engine
-    initializer 'front_man.images_helper' do
-      ActiveSupport.on_load(:action_view) do
-        include FrontMan::ImagesHelper
-      end
-    end
-  end
-end