shill 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b37e2e8280c1b400c3d5a9d8faa3a292eadc7835090f01511c1d28658d101d1
-  data.tar.gz: 8c9584c5fddc36f5aa515119244687771ac4b2cc32aec5be0e4f2318627a8147
+  metadata.gz: 4f0ffc8cf45e7690dea17a48ab6370bb9016df49f0e6ca70b701c782316db2ae
+  data.tar.gz: 37f21d5c06c84e3f4afd104331476fb17a8f5789cf6c1bfd230678b5b94218e1
 SHA512:
-  metadata.gz: 7ebf69a9daf634fc8d66547044274e8cd15df36e14fb5216e4fca278ff32c7b3b0b17bb0f7bb2216fdb11aee1322e16452e3476d5d3864b6604ae6af680e18ea
-  data.tar.gz: f1d1170b2606988b8bffee707851191bb921a84c52deb723f27fe7e317bd92ef2b30fe1b803557ca1e656975dd51ff1a7b251e993f1492af2b4f9934a25dcc17
+  metadata.gz: fa60818f20a34a3080ea6dc83f58a005b546ce59f56a277b245e1f46e6332e284de696e3fe654000b3e8fd0aa3d34ab4401dd3145e0f2a9bb86073a19c8b4329
+  data.tar.gz: a2add6060a5e0af99d10faadd0ce372d054c1780b7515620dae1a6bcc66b33b1e17735c0c2dd9e6a81ca321d8ea9e99a29b3fb236e45e0b8414131d3a6b7076c

data/README.md

@@ -14,8 +14,7 @@ A tiny, dependency-free Ruby gem that fetches and exposes a list of projects fro
 Add the gem to your project:
 
 ```ruby
-gem "shill", github: "marckohlbrugge/shill"   # until published on RubyGems
-gem "shill"                                   # once published
+gem "shill"
 ```
 
 Then install:
@@ -179,3 +178,27 @@ Shill.projects(refresh: true)   # bypasses cache and stores fresh data
 ```
 
 ---
+
+## Rails view helpers
+
+Once the gem is loaded in a Rails app, you can access the data directly in any view:
+
+```erb
+<ul>
+  <% shill_projects.each do |project| %>
+    <li>
+      <%= link_to project.name, project.url %> — <%= project.description %>
+    </li>
+  <% end %>
+</ul>
+```
+
+Need just one?
+
+```erb
+<% if (proj = shill_random_project) %>
+  <%= link_to proj.name, proj.url %>
+<% end %>
+```
+
+---

data/lib/shill/helpers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Shill
+  # View-helper methods for Rails
+  module Helpers
+    # Returns all cached projects (see Shill.projects)
+    def shill_projects
+      Shill.projects
+    end
+
+    # Returns a single random project
+    def shill_random_project
+      Shill.random_project
+    end
+  end
+end 

data/lib/shill/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Shill
+  class Railtie < ::Rails::Railtie
+    initializer "shill.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include Shill::Helpers
+      end
+    end
+  end
+end 

data/lib/shill/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shill
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/shill.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "shill/version"
+# Autoload internal files
+require_relative "shill/helpers"
+
+# Load Railtie if Rails is present
+if defined?(Rails::Railtie)
+  require_relative "shill/railtie"
+end
 
 module Shill
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shill
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Köhlbrugge
@@ -24,6 +24,8 @@ files:
 - README.md
 - Rakefile
 - lib/shill.rb
+- lib/shill/helpers.rb
+- lib/shill/railtie.rb
 - lib/shill/version.rb
 - sig/shill.rbs
 homepage: https://github.com/marckohlbrugge/shill