weather-icons-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66cc31dedd6673806fc377eba6d42b80e33f3586
-  data.tar.gz: d21b0ada46ff297aa00a36b61cd7ff627d4cf956
+  metadata.gz: e2749e85b930c8561fde3a12cc0f0af280d0d5c1
+  data.tar.gz: 9129d36017c98dacc724ac3c152b94d5711c04a3
 SHA512:
-  metadata.gz: 63dc1cf232b3a4d3182d01354a40f313602dfd1b7ca8163ebad48c289ab73ce5eda998ee3a6baf187a91e5a1833270c584548176e5a0a2577233062f5c2d9fa0
-  data.tar.gz: f9a0d24e3f5f564e4f61e0e5a981b8a70ab9322d30aabf6f7d66c9a8d4e16b2e8b825f2a57718007976771dfb65d2ae3b5098ea2a8bfba67874c75e72ec3a4dd
+  metadata.gz: 2158c03b377609b45ebd1795b887a0ee37c78d40205bf9860aa67b1d8f8a4a74b488108f6f07d59a4dae10211d3dcd1263a912bf530e7080826ddb1eed5f2b4d
+  data.tar.gz: b4da17ffb6388d6da0e350085f9a2aa4d112236e7f35660dcd63657df3fe97193e62aeb6e106071d62e751d48c048554c209ba1ee6a19fc77cbc3a02872bd88b

data/README.md

@@ -1,40 +1,128 @@
-#In the midst of adapting this into a gem. I'm not the original author, all credit goes to Erik Flowers.
 
-# Weather Icons
-*Version Beta 1 - August 3rd 2013*
+# Weather::Icons::Rails [![Gem Version](https://badge.fury.io/rb/weather-icons-rails@2x.svg)](http://rubygems.org/gems/weather-icons-rails)
+Weather-Icons-Rails gem for use in Ruby projects
 
-## A free, open source icon-font of Weather icons
+## A free, open source font of Weather icons
 
 Weather Icons is a font of 92 weather themed icons, ready to be dropped right into [Bootstrap](http://www.getbootstrap.com) or any other project.
 
-Inspired by [Font Awesome](http://fontawesome.io/), They work in essentially the same way. They are infinitley scalable and any CSS that can be applied to text can be applied to them. All you need to do to insert an icon is add the class to an "i" element:
-
-``<i class="wi-day-lightning"></i>``
-
-At this time, there are no other effects/mixins to do advanced icon manipulation yet.
+Inspired by [Font Awesome](http://fontawesome.io/), They work in essentially the same way. They are infinitely scalable and any CSS that can be applied to text can be applied to them. All you need to do to insert an icon is add the class to an "i" element like this: `<i class="wi wi-day-lightning"></i>`
 
 ####[View demo and full icon reference](http://erikflowers.github.io/weather-icons/)
 
 ## Getting Started
-Getting started is easy. First, put the fonts in the directory ABOVE your css directory. By default, the fonts are referencing a ../font/ folder that is on the same level as /css. This can be changed via the `@WeatherIconPath` variable in variables.less
-
-Include in your main .less file `weather-icons/weather-icons.less` and that is all you need to do.
-
-#### CSS Only Method
-If you just want to add a css file to your project with no Less compiling, you just need to reference the `weather-icons.css` included in the css folder. *If you are not familiar with using Bootstrap, or using Bootstrap in the precompiled Less mode, I would reccommend you give it a try)*
-
-## Version Beta 1
-This is my first attempt at a [Bootstrap](http://www.getbootstrap.com) and/or web ready icon-font, so there will be updates and improvements. It is best to download the [repo](http://www.github.com/erikflowers/weather-icons) from Github if you want to keep up to date. Please report any issues or requests to the repository here
 
-The icon designs are originally by [Lukas Bischoff](http://www.twitter.com/artill). The font has been modified slightly for icon-font usage, and turned into a HTML/CSS/LESS addon by [me (Erik)](http://www.helloerik.com).
+The original author Erik put these web fonts together, I have packaged his hard work into a simple Sass based gem.
+
+To install simply add
+
+```ruby
+gem 'weather-icons-rails'
+```
+then after bundeling add
+
+```css
+*= require weather-icons
+```
+
+right before `*= require_self`
+
+###### Now it's time to have at it, and class up your HTML.
+
+To add icons anywhere in your html just add one of these tags with your symbole of choice:
+
+```html
+<i class="wi wi-day-lightning"></i>
+```
+## If that wasn't easy enough, Helpers make it even easier!
+
+In your view just add these to your HAML or ERB:
+```ruby
+wi_icon('day-lightning')
+# => <i class="wi wi-day-lightning"></i>
+```
+```ruby
+wi_icon('day-lightning', '', class: 'strong')
+# => <i class="wi wi-day-lightning strong"></i>
+# Although this currently does not change the actual look of the font yet. Any suggestions?
+```
+```ruby
+wi_icon "day-lightning lg", class: "text-muted pull-left"
+# => <i class="wi wi-day-lightning wi-lg text-muted pull-left"></i>
+```
+```ruby
+wi_icon('day-lightning', 'Weather Icons', id: 'lightning', class: 'strong')
+# => <i id="lightning" class="wi wi-day-lightning strong"></i> Weather Icons
+```
+
+```ruby
+content_tag(:li, wi_icon("day-lightning li", text: "Bulleted list item"))
+# => <li><i class="wi wi-day-lightning wi-li"></i> Bulleted list item</li>
+```
+```ruby
+wi_stacked_icon "day-lightning", base: "day-cloudy-gusts"
+# => <span class="fa-stack">
+# =>   <i class="wi wi-day-cloudy-gusts wi-stack-2x"></i>
+# =>   <i class="wi wi-day-lightning wi-stack-1x"></i>
+# => </span>
+
+wi_stacked_icon "day-lightning inverse", base: 'day-cloudy-gusts', class: "pull-right", text: "Hi!"
+# => <span class="wi-stack pull-right">
+# =>   <i class="wi wi-day-cloudy-gusts wi-stack-2x"></i>
+# =>   <i class="wi wi-day-lightning wi-inverse wi-stack-1x"></i>
+# => </span> Hi!
+```
+
+##Fancy css classes for fancy people.
+
+Supported classes:
+
+```css
+  .wi-spin
+
+  .wi-rotate-90
+  .wi-rotate-180
+  .wi-rotate-270
+
+  .wi-flip-horizontal
+  .wi-flip-vertical  
+
+  .wi-ul
+  .wi-li
+
+  .wi-md
+  .wi-lg
+  .wi-xl
+  .wi-2x
+  .wi-3x
+  ...
+  .wi-9x
+
+  .wi-fw // Fixed Width Icons
+
+  .wi-border
+```
+
+## Version 0.0.2 (BETA?)
+This is my first attempt at making a gem, please feel free to send me any pull requests or questions. I'm happy to help and or learn. Thanks!
+
+The icon designs are originally by [Lukas Bischoff](http://www.twitter.com/artill). The font has been modified slightly for icon-font usage, which was then turned into a HTML/CSS/LESS addon by [Erik Flowers](http://www.helloerik.com). My gem was originally based off of the hard work over at [Font Awesome Rails](https://github.com/bokmann/font-awesome-rails) and then updated to closely mirror the Sass based version at [Font Awesome Sass](https://github.com/FortAwesome/font-awesome-sass).
 
 ### Collaboration
-If you feel so inclined to add icon ideas, icon art, or other fixes/changes to how the package works, feel free to help! I'd also love it if someone wanted to make this a component as well for bower, npm, component, etc. No idea how to do that myself (yet).
+Any additional icon ideas, icon art, or other fixes/changes to how the package works are more than welcome.
 
 ## Credit
-None of this would be  possible without [Bootstrap](http://www.getbootstrap.com), [Font Awesome](http://fontawesome.io/) and [Lukas Bischoff](http://www.twitter.com/artill). I just put it all together into a neat package. Cheatsheet provided by Michael Woywod.
+None of this would be possible without [Bootstrap](http://www.getbootstrap.com), [Font Awesome](http://fontawesome.io/), [Lukas Bischoff](http://www.twitter.com/artill), and [Erik Flowers](http://www.helloerik.com). I just put it into a gem and added the helpers, and extra styling css classes from font-awesome-sass. Cheatsheet provided by Michael Woywod.
 
 Weather Icons licensed under [SIL OFL 1.1](http://scripts.sil.org/OFL) &mdash; Code licensed under [MIT License](http://opensource.org/licenses/mit-license.html)  &mdash; Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0)
 
 ## Contact
-Weather Icons is maintained by me, Erik Flowers. Reach me at [@Erik_UX](http://www.twitter.com/Erik_UX) or at [helloerik.com](http;//www.helloerik.com).
+Weather Icons Rails is maintained by me, Cody Schaaf. Reach me at [@TheCodingCody](http://www.twitter.com/TheCodingCody) or through [GitHub](https://github.com/CodySchaaf/weather-icons-rails).
+
+* The Weather Icons font is
+  licensed under the [SIL Open Font License](http://scripts.sil.org/OFL).
+* Weather Icons CSS files are
+  licensed under the
+  [MIT License](http://opensource.org/licenses/mit-license.html).
+* The remainder of the weather-icons-rails project is licensed under the
+  [MIT License](http://opensource.org/licenses/mit-license.html).

data/app/helpers/weather_icons/rails/icon_helper.rb

@@ -0,0 +1,92 @@
+# module WeatherIcons
+#   module Rails
+#     module IconHelper
+#       # Creates an icon tag given an icon name and possible icon
+#       # modifiers.
+#       #
+#       # Examples
+#       #
+#       #   wi_icon "camera-retro"
+#       #   # => <i class="wi-camera-retro"></i>
+#       #
+#       #   wi_icon "camera-retro", text: "Take a photo"
+#       #   # => <i class="wi-camera-retro"></i> Take a photo
+#       #
+#       #   wi_icon "camera-retro 2x"
+#       #   # => <i class="wi-camera-retro wi-2x"></i>
+#       #   wi_icon ["camera-retro", "4x"]
+#       #   # => <i class="wi-camera-retro wi-4x"></i>
+#       #   wi_icon "spinner spin lg"
+#       #   # => <i class="wi-spinner wi-spin wi-lg">
+#       #
+#       #   wi_icon "quote-left 4x", class: "pull-left"
+#       #   # => <i class="wi-quote-left wi-4x pull-left"></i>
+#       #
+#       #   wi_icon "user", data: { id: 123 }
+#       #   # => <i class="wi-user" data-id="123"></i>
+#       #
+#       #   content_tag(:li, wi_icon("check li", text: "Bulleted list item"))
+#       #   # => <li><i class="wi-check wi-li"></i> Bulleted list item</li>
+#       def wi_icon(names = "flag", options = {})
+#         classes = []
+#         classes.concat Private.icon_names(names)
+#         classes.concat Array(options.delete(:class))
+#         text = options.delete(:text)
+#         icon = content_tag(:i, nil, options.merge(:class => classes))
+#         Private.icon_join(icon, text)
+#       end
+#
+#       # Creates an stack set of icon tags given a base icon name, a main icon
+#       # name, and possible icon modifiers.
+#       #
+#       # Examples
+#       #
+#       #   wi_stacked_icon "twitter", base: "square-o"
+#       #   # => <span class="wi-stack">
+#       #   # =>   <i class="wi-square-o wi-stack-2x"></i>
+#       #   # =>   <i class="wi-twitter wi-stack-1x"></i>
+#       #   # => </span>
+#       #
+#       #   wi_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
+#       #   # => <span class="wi-stack pull-right">
+#       #   # =>   <i class="wi-square wi-stack-2x"></i>
+#       #   # =>   <i class="wi-terminal wi-inverse wi-stack-1x"></i>
+#       #   # => </span> Hi!
+#       #
+#       #   wi_stacked_icon "camera", base: "ban-circle", reverse: true
+#       #   # => <span class="wi-stack">
+#       #   # =>   <i class="wi-camera wi-stack-1x"></i>
+#       #   # =>   <i class="wi-ban-circle wi-stack-2x"></i>
+#       #   # => </span>
+#       def wi_stacked_icon(names = "flag", options = {})
+#         classes = Private.icon_names("stack").concat(Array(options.delete(:class)))
+#         base_names = Private.array_value(options.delete(:base) || "square-o").push("stack-2x")
+#         names = Private.array_value(names).push("stack-1x")
+#         base = wi_icon(base_names, options.delete(:base_options) || {})
+#         icon = wi_icon(names, options.delete(:icon_options) || {})
+#         icons = [base, icon]
+#         icons.reverse! if options.delete(:reverse)
+#         text = options.delete(:text)
+#         stacked_icon = content_tag(:span, safe_join(icons), options.merge(:class => classes))
+#         Private.icon_join(stacked_icon, text)
+#       end
+#
+#       module Private
+#         extend ActionView::Helpers::OutputSafetyHelper
+#
+#         def self.icon_join(icon, text)
+#           return icon if text.blank?
+#           safe_join([icon, ERB::Util.html_escape(text)], " ")
+#         end
+#
+#         def self.icon_names(names = [])
+#           array_value(names).map { |n| "wi-#{n}" }
+#         end
+#
+#         def self.array_value(value = [])
+#           value.is_a?(Array) ? value : value.to_s.split(/\s+/)
+#         end
+#       end
+#     end
+#   end
+# end

data/lib/weather-icons-rails/rails.rb

@@ -0,0 +1,58 @@
+module WeatherIcons
+  module Rails
+    class << self
+      def load!
+        if rails?
+          register_rails_engine
+        end
+
+        if compass?
+          register_compass_extension
+        end
+      end
+
+      def gem_path
+        @gem_path ||= File.expand_path('..', File.dirname(__FILE__))
+      end
+
+      def stylesheets_path
+        File.join(assets_path, 'stylesheets')
+      end
+
+      def fonts_path
+        File.join(assets_path, 'fonts')
+      end
+
+      def assets_path
+        @assets_path ||= File.join(gem_path, 'vendor', 'assets')
+      end
+
+      def compass?
+        defined?(::Compass)
+      end
+
+      def rails?
+        defined?(::Rails)
+      end
+
+      private
+
+      def register_compass_extension
+        ::Compass::Frameworks.register(
+          'weather-icons-rails',
+          path: gem_path,
+          stylesheets_directory: stylesheets_path,
+          templates_directory: File.join(gem_path, 'templates')
+        )
+      end
+
+      def register_rails_engine
+        require 'sass-rails'
+        require 'weather-icons-rails/rails/rails/engine'
+        require 'weather-icons-rails/rails/rails/railtie'
+      end
+    end
+  end
+end
+
+WeatherIcons::Rails.load!

data/lib/weather-icons/rails/rails/helpers.rb

@@ -8,28 +8,28 @@ module WeatherIcons
         # Examples
         #
         #   wi_icon "camera-retro"
-        #   # => <i class="wi-camera-retro"></i>
+        #   # => <i class="wi wi-camera-retro"></i>
         #
         #   wi_icon "camera-retro", text: "Take a photo"
-        #   # => <i class="wi-camera-retro"></i> Take a photo
+        #   # => <i class="wi wi-camera-retro"></i> Take a photo
         #
         #   wi_icon "camera-retro 2x"
-        #   # => <i class="wi-camera-retro wi-2x"></i>
+        #   # => <i class="wi wi-camera-retro wi-2x"></i>
         #   wi_icon ["camera-retro", "4x"]
-        #   # => <i class="wi-camera-retro wi-4x"></i>
+        #   # => <i class="wi wi-camera-retro wi-4x"></i>
         #   wi_icon "spinner spin lg"
-        #   # => <i class="wi-spinner wi-spin wi-lg">
+        #   # => <i class="wi wi-spinner wi-spin wi-lg">
         #
         #   wi_icon "quote-left 4x", class: "pull-left"
-        #   # => <i class="wi-quote-left wi-4x pull-left"></i>
+        #   # => <i class="wi wi-quote-left wi-4x pull-left"></i>
         #
         #   wi_icon "user", data: { id: 123 }
-        #   # => <i class="wi-user" data-id="123"></i>
+        #   # => <i class="wi wi-user" data-id="123"></i>
         #
         #   content_tag(:li, wi_icon("check li", text: "Bulleted list item"))
-        #   # => <li><i class="wi-check wi-li"></i> Bulleted list item</li>
+        #   # => <li><i class="wi wi-check wi-li"></i> Bulleted list item</li>
         def wi_icon(names = "flag", options = {})
-          classes = []
+          classes = ['wi ']
           classes.concat Private.icon_names(names)
           classes.concat Array(options.delete(:class))
           text = options.delete(:text)
@@ -44,20 +44,20 @@ module WeatherIcons
         #
         #   wi_stacked_icon "twitter", base: "square-o"
         #   # => <span class="wi-stack">
-        #   # =>   <i class="wi-square-o wi-stack-2x"></i>
-        #   # =>   <i class="wi-twitter wi-stack-1x"></i>
+        #   # =>   <i class="wi wi-square-o wi-stack-2x"></i>
+        #   # =>   <i class="wi wi-twitter wi-stack-1x"></i>
         #   # => </span>
         #
         #   wi_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
         #   # => <span class="wi-stack pull-right">
-        #   # =>   <i class="wi-square wi-stack-2x"></i>
-        #   # =>   <i class="wi-terminal wi-inverse wi-stack-1x"></i>
+        #   # =>   <i class="wi wi-square wi-stack-2x"></i>
+        #   # =>   <i class="wi wi-terminal wi-inverse wi-stack-1x"></i>
         #   # => </span> Hi!
         #
         #   wi_stacked_icon "camera", base: "ban-circle", reverse: true
         #   # => <span class="wi-stack">
-        #   # =>   <i class="wi-camera wi-stack-1x"></i>
-        #   # =>   <i class="wi-ban-circle wi-stack-2x"></i>
+        #   # =>   <i class="wi wi-camera wi-stack-1x"></i>
+        #   # =>   <i class="wi wi-ban-circle wi-stack-2x"></i>
         #   # => </span>
         def wi_stacked_icon(names = "flag", options = {})
           classes = Private.icon_names("stack").concat(Array(options.delete(:class)))

data/lib/weather-icons/rails/version.rb

@@ -1,5 +1,5 @@
 module WeatherIcons
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weather-icons-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cody Schaaf
@@ -144,7 +144,9 @@ files:
 - app/assets/stylesheets/weather-icons/_spinning.css.scss
 - app/assets/stylesheets/weather-icons/_stacked.css.scss
 - app/assets/stylesheets/weather-icons/_variables.css.scss
+- app/helpers/weather_icons/rails/icon_helper.rb
 - lib/weather-icons-rails.rb
+- lib/weather-icons-rails/rails.rb
 - lib/weather-icons/rails.rb
 - lib/weather-icons/rails/rails/engine.rb
 - lib/weather-icons/rails/rails/helpers.rb