museum 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e282a25600d3d0ff95bab2358a0aeb8196b68e31
-  data.tar.gz: 69d13ee3c7f747f9f51bc727c8b7594bec229cb7
+  metadata.gz: 1bcdfd2b1789b7436ee0d0b0a2c70f084e5dafe6
+  data.tar.gz: 5e29c1735e759122a8b8ce218d8319bd0cd1dd1b
 SHA512:
-  metadata.gz: dee67d95ab4b5842b28309c04e70780416544dd96c30caa8db2e3dac11901108eff55163c85502950ef1dfc3adf0daf3e0d3111ded904c06a5f019ee7f7eae79
-  data.tar.gz: 415e745598d7bfaed01db92d88e26a4fc15e0218658d9e43c336ca8ef17bc61245273f735c98cbd49936f8f6b7fbd79632b301a74c0bef668e89cf1f5e6729ef
+  metadata.gz: 6d90b7485a57a8539365d5037f6012c7316ff245dd8cc595228cf880b31d4a05bf8adb92a50c94972ef1dd328c9a624068066e93252308d2e406c64bc1acf541
+  data.tar.gz: d2d53d23186096daf560b9f6c97872f6c81530ed323e7fa5f324c1429bf7cfe18f1ce0778cb75ba3d464d77470001eaf89de075279790493d15f26e1f2f2d9a8

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gem 'rails', '~> 5.0'
 gem 'rails-i18n', '~> 5.0'
 gem 'jquery-rails', '~> 4.0'
+gem 'sass-rails', '~> 5.0'
 gem 'haml-rails', '~> 0.9'
 gem 'friendly_id', '~> 5.1'
 gem 'jeweler', '~> 2.3'

data/README.md

@@ -1,5 +1,4 @@
-Museum
-===========
+# Museum
 
 **Updated for Rails 5**
 
@@ -9,8 +8,13 @@ Museum
 
 For organizations that want to market a gem with the latest updates, Museum syncs your gems' data via arbitrary APIs so that your software marketing website stays up to date with the latest information about your gems.
 
-Installation
-----------------------------
+### Index Page
+![Index Page Screenshot](http://gemvein.com/assets/screenshots/museum-cases-index.png)
+
+### Show Page
+![Show Page Screenshot](http://gemvein.com/assets/screenshots/museum-cases-show.png)
+
+## Installation
 
 First, add the gem to your Gemfile
 
@@ -24,8 +28,64 @@ Next, run the following commands
 
 How you edit your database is up to you, but RailsAdmin is my favorite.
 
-Contributing to Museum
-----------------------------
+## See Museum in Action
+[Gem Vein](http://www.gemvein.com) is a good example of a site whose information about software is kept fresh with Museum.
+
+## What You Can Do
+
+To copy the default views to your app directory:
+
+    > rails g museum:views
+    
+### Cases
+
+These are the gems whose information you wish to keep fresh.
+
+Create some instances of `Museum::Case` with the `name` of the gem and optionally, a human-readable `title`.
+
+    Museum::Case.new(
+      name: 'bootswitch',
+      title: 'Bootswitch'
+    )
+    Museum::Case.new(
+      name: 'customizable_bootstrap',
+      title: 'Customizable Bootstrap'
+    )
+    Museum::Case.new(
+      name: 'bootstrap_leather',
+      title: 'Bootstrap Leather'
+    )
+
+### Loupes
+
+These are the APIs containing information about your gems.
+
+    Museum::Loupe.new(
+      title: 'RubyGems',
+      uri_template: 'https://www.rubygems.org/api/v1/gems/%{name}.json',
+      data_format: 'json'
+    )
+    Museum::Loupe.new(
+      title: 'GitHub',
+      uri_template: 'https://api.github.com/repos/%{user}/%{name}',
+      data_format: 'json'
+    )
+    Museum::Loupe.new(
+      title: 'GitHub README',
+      uri_template: 'https://api.github.com/repos/%{user}/%{name}/readme',
+      data_format: 'json'
+    )
+    
+### Case Details
+This is where Museum stores the data it retrieves with Loupes. To access them, try something like:
+
+    # In your controller
+    @case = Museum::Case.find_by!(name: 'bootswitch')
+    
+    # And then, in your view:
+    @case.loupe('rubygems').detail('downloads')
+
+## Contributing to Museum
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -35,8 +95,7 @@ Contributing to Museum
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-Copyright
----------
+## Copyright
 
-Copyright (c) 2014-2016 Gem Vein. See LICENSE.txt for further details.
+Copyright (c) 2014-2017 Gem Vein. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/app/views/museum/cases/index.html.haml

@@ -1,5 +1,10 @@
 %h1= :cases.l
 
 - for gem_case in @cases
-  %h2= gem_case.title
-  = link_to gem_case.name, [museum, gem_case], class: 'btn btn-large btn-success'
+  %h2
+    = link_to gem_case.title, [museum, gem_case]
+    %small
+      v#{gem_case.loupe('rubygems').detail('version')}
+      (#{gem_case.name})
+  %p
+    = gem_case.loupe('rubygems').detail('info')

data/app/views/museum/cases/show.html.haml

@@ -4,8 +4,18 @@
 
 - for loupe in Museum::Loupe.all
   %h3= loupe.title
-  %table
+  %dl
     - for detail in @case.loupe(loupe.slug)
-      %tr
-        %th= detail.key
-        %td= detail.value
+      %dt
+        = detail.key.titleize.gsub(/( Ur.$)/) { $1.upcase }
+      %dd
+        %code
+          @case.loupe('#{loupe.slug}').detail('#{detail.key}')
+      %dd
+        - case detail.value
+          - when nil
+            %em.disabled nil
+          - when ''
+            %em.disabled blank
+          - else
+            = detail.value

data/lib/generators/museum/install/install_generator.rb

@@ -6,7 +6,7 @@ module Museum
     include Rails::Generators::Migration
     
     def hello
-      output "Museum is ready to announce your gems in style.", :magenta
+      output "Museum is ready to display your gems in style.", :magenta
     end
     
     # all public methods in here will be run in order

data/museum.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: museum 0.5.3 ruby lib
+# stub: museum 0.5.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "museum"
-  s.version = "0.5.3"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Karen Lundgren"]
-  s.date = "2017-03-10"
+  s.date = "2017-03-14"
   s.description = "For organizations that want to market a gem in style, Museum uses APIs to provide you with an ever-fresh marketing site for your gems."
   s.email = "karen.e.lundgren@gmail.com"
   s.extra_rdoc_files = [
@@ -57,6 +57,7 @@ Gem::Specification.new do |s|
     "museum.gemspec",
     "spec/controllers/cases_controller_spec.rb",
     "spec/dummy/Rakefile",
+    "spec/dummy/app/assets/stylesheets/application.scss",
     "spec/dummy/app/controllers/application_controller.rb",
     "spec/dummy/app/helpers/application_helper.rb",
     "spec/dummy/app/models/application_record.rb",
@@ -135,6 +136,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rails>, ["~> 5.0"])
       s.add_runtime_dependency(%q<rails-i18n>, ["~> 5.0"])
       s.add_runtime_dependency(%q<jquery-rails>, ["~> 4.0"])
+      s.add_runtime_dependency(%q<sass-rails>, ["~> 5.0"])
       s.add_runtime_dependency(%q<haml-rails>, ["~> 0.9"])
       s.add_runtime_dependency(%q<friendly_id>, ["~> 5.1"])
       s.add_runtime_dependency(%q<jeweler>, ["~> 2.3"])
@@ -151,6 +153,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rails>, ["~> 5.0"])
       s.add_dependency(%q<rails-i18n>, ["~> 5.0"])
       s.add_dependency(%q<jquery-rails>, ["~> 4.0"])
+      s.add_dependency(%q<sass-rails>, ["~> 5.0"])
       s.add_dependency(%q<haml-rails>, ["~> 0.9"])
       s.add_dependency(%q<friendly_id>, ["~> 5.1"])
       s.add_dependency(%q<jeweler>, ["~> 2.3"])
@@ -168,6 +171,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rails>, ["~> 5.0"])
     s.add_dependency(%q<rails-i18n>, ["~> 5.0"])
     s.add_dependency(%q<jquery-rails>, ["~> 4.0"])
+    s.add_dependency(%q<sass-rails>, ["~> 5.0"])
     s.add_dependency(%q<haml-rails>, ["~> 0.9"])
     s.add_dependency(%q<friendly_id>, ["~> 5.1"])
     s.add_dependency(%q<jeweler>, ["~> 2.3"])

data/spec/dummy/app/assets/stylesheets/application.scss

@@ -0,0 +1,56 @@
+body {
+  font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+}
+
+.container {
+  width: 800px;
+  margin: auto;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+.h1,
+.h2,
+.h3,
+.h4,
+.h5,
+.h6 {
+  margin-bottom: 0;
+  margin-top: .5em;
+
+  &:first-child {
+    margin-top: 0;
+  }
+
+  small {
+    display: block;
+  }
+}
+
+p,
+ol,
+ul {
+  margin-bottom: 1em;
+  margin-top: 0;
+}
+
+dt {
+  margin-top: 1em;
+  font-weight: bold;
+}
+
+dd {
+  margin-left: 0;
+}
+
+code {
+  color: #9c9;
+}
+
+.disabled {
+  color: #999;
+}

data/spec/dummy/app/views/layouts/application.html.haml

@@ -3,7 +3,9 @@
   %head
     %link{:rel=>"shortcut icon", :href=>"/favicon.ico"}
     %meta{"http-equiv"=>"Content-Type", :content=>"text/html;charset=utf-8"}
+    = stylesheet_link_tag 'application'
     %title Dummy Application
 
   %body{:class => controller.controller_name}
-    = yield
+    .container
+      = yield

data/spec/dummy/config/initializers/assets.rb

@@ -3,9 +3,12 @@
 # Version of your assets, change this if you want to expire all your assets.
 Rails.application.config.assets.version = '1.0'
 
+# Change the path that assets are served from
+Rails.application.config.assets.prefix = "/assets"
+
 # Add additional assets to the asset load path
 # Rails.application.config.assets.paths << Emoji.images_path
 
 # Precompile additional assets.
 # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-# Rails.application.config.assets.precompile += %w( search.js )
+# Rails.application.config.assets.precompile += %w( search.js )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: museum
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Karen Lundgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +281,7 @@ files:
 - museum.gemspec
 - spec/controllers/cases_controller_spec.rb
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/stylesheets/application.scss
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/application_record.rb