mitlibraries-theme 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71c3d6081f01f45f4cc3364bb9389219723e6df99df2c418b17c5efc6c5b881
-  data.tar.gz: cfaef0cb2bbff68b3ce7ba16722b12e5951fbccf324faedfc7010718b63144fa
+  metadata.gz: ecf72d8fc3f947feff484f614fbd78299b988b60f2917289b1166b8d8045eb33
+  data.tar.gz: cced976628bcad6adfd7ae13d7fec3238c9692aa8abb13575a56990882353c74
 SHA512:
-  metadata.gz: ec9c85ad890bc7c9f8f590da9ee052bbfedb22d80edf1624d1d2a58a917107d90548181963304bc47865c4a1abee4d32baea4907f2ca35c5e900fe1b2e7cdcfe
-  data.tar.gz: bc8142960a8ba2e63d03bd45d7f8954a2517e37e23e60082cffc542e9912e4e2afe58ed014a09902dd4872d13f9fb65778f3cdd6a0d562bc13a73341cb0221a9
+  metadata.gz: 14ec4af05c669a9f5335ab98bf8cfacaab6acdd2950145c0160aaeb4569a2d3b1b60071316439a7c29e53394130462049a8dda0de6af40b842fc6f2c9c1b9fa9
+  data.tar.gz: 514c0869fa969fa8c96bdf55e48b6312f5e612fdf806c856ac74335b5901fe46378d2507b75d5af045cd0a365df6601c42f9812f8e0e6ae0585ade814133ebc5

data/Makefile

@@ -0,0 +1,56 @@
+.PHONY: help fetch update cleanup dist publish
+SHELL=/bin/bash
+GEMSPEC=$(shell ls *.gemspec | head -1)
+VERSION=$(shell ruby -e 'puts Gem::Specification::load("$(GEMSPEC)").version')
+PROJECT=$(shell ruby -e 'puts Gem::Specification.load("$(GEMSPEC)").name')
+GEM=$(PROJECT)-$(VERSION).gem
+
+help: ## Print this message
+	@awk 'BEGIN { FS = ":.*##"; print "Usage:  make <target>\n\nTargets:" } \
+		/^[-_[:alpha:]]+:.?*##/ { printf "  %-15s%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+fetch: clean ## Grab latest from theme repo (auto runs clean first)
+	mkdir -p tmp
+	curl -o tmp/assets.zip https://codeload.github.com/MITLibraries/mitlib-style/zip/master
+	unzip -o -d tmp tmp/assets.zip
+
+update: fetch ## Synchronize latest (auto runs clean and fetch first)
+	# cleanup targets first in case assets were removed
+	rm -rf vendor/assets/images/
+	rm -rf vendor/assets/stylesheets/
+
+	mkdir vendor/assets/images/
+	mkdir vendor/assets/stylesheets/
+
+	cp -R tmp/mitlib-style-master/_assets/i/* vendor/assets/images
+	cp -R tmp/mitlib-style-master/_assets/sass/* vendor/assets/stylesheets
+
+	rm -rf vendor/assets/stylesheets/apps/
+	rm -f vendor/assets/stylesheets/ebooks-main.scss
+	rm -f vendor/assets/stylesheets/guide-helper.scss
+	rm -f vendor/assets/stylesheets/quicksubmit.sass
+
+	# We need to double $ so make doesn't think it's a variable and escape the $ for bash. Hence \$$.
+	sed -i '' "s+url('#{\$$image-path}/vi-shape7-tp.svg')+image-url('vi-shape7-tp.svg')+g" vendor/assets/stylesheets/elements/*.scss
+
+	@tput setaf 2
+	@tput bold
+	@echo "Assets updated. Make sure to update version in:"
+	@echo "  lib/mitlibraries/theme/version.rb"
+	@echo "before building with 'make dist'"
+	@tput sgr0
+
+clean: ## Delete downloaded zip and extracted files
+	rm -f tmp/assets.zip
+	rm -rf tmp/mitlib-style-master
+
+dist: ## Build the gem from the current gemspec
+	gem build mitlibraries-theme.gemspec
+	@tput setaf 2
+	@tput bold
+	@echo "Finished building gem. To test locally add to your project Gemfile:"
+	@echo "  gem 'mitlibraries-theme', path: '$(shell pwd)'"
+	@tput sgr0
+
+publish: ## Publish the gem version defined in the gemspec
+	gem push "$(GEM)"

data/README.md

@@ -57,11 +57,36 @@ called multiple times the results are concatenated. This is intended primarily
 for adding external support libraries. For JS you are writing, include via
 `application.scss` as normal.
 
+## Adding Additional Meta headers to HTML Head
+
+You can load additional meta headers to individual pages using:
+
+```
+<% content_for :additional_meta_tag do %>
+  <meta name="description" content="Words and stuff about stuff or something.">
+  <meta name="keywords" content="words,stuff,yoyos">
+<% end %>
+```
+
+This can appear as many times as you need on as many templates as you need. If
+called multiple times the results are concatenated.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Building and publishing this gem is handled via the `Makefile`.
+
+Run `make help` for details.
+
+If your goal is to fetch the latest assets from the style repo and publish the
+changes, this would get you there:
+- `make update`
+- manually update the version in `lib/mitlibraries/theme/version.rb`
+- `make dist`
+- test the gem in a local version of a site that uses it with the info the previous command provided on completion
+- commit and PR
+- `make publish`
 
 ## Contributing
 

data/app/views/layouts/_head.html.erb

@@ -4,6 +4,8 @@
 <title><%= content_for?(:title) ? yield(:title) : "  MIT Libraries" %></title>
 <%= csrf_meta_tags %>
 
+<%= yield :additional_meta_tag %>
+
 <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
 <!--[if lt IE 9]>
   <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.6.1/html5shiv.js" type="text/javascript"></script>
@@ -19,28 +21,24 @@
 <%= render partial: "layouts/js_exception_handler" %>
 <%= javascript_include_tag "application" %>
 
+<script type='text/javascript' src='https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js'></script>
+
 <%= yield :additional_js %>
 
-<% if (ENV['GOOGLE_ANALYTICS']) %>
+<% if (ENV['MATOMO_URL'].present? && ENV['MATOMO_SITE_ID'].present?) %>
+<!-- Matomo -->
 <script type="text/javascript">
-  // Google Analytics
-
-  (function(i,s,o,g,r,a,m){
-    i['GoogleAnalyticsObject']=r;
-    i[r]=i[r]||function(){
-      (i[r].q=i[r].q||[]).push(arguments)
-    };
-    i[r].l=1*new Date();
-    a=s.createElement(o);
-    m=s.getElementsByTagName(o)[0];
-    a.async=1;
-    a.src=g;
-    m.parentNode.insertBefore(a,m);
-
-  }(window,document,'script','https://www.google-analytics.com/analytics.js','ga'));
-
-  ga('create', '<%= ENV['GOOGLE_ANALYTICS'] %>', 'auto');
-  ga('send', 'pageview');
-
+  var _paq = window._paq || [];
+  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+  _paq.push(['trackPageView']);
+  _paq.push(['enableLinkTracking']);
+  (function() {
+    var u='<%= ENV['MATOMO_URL'] %>';
+    _paq.push(['setTrackerUrl', u+'matomo.php']);
+    _paq.push(['setSiteId', '<%= ENV['MATOMO_SITE_ID'] %>']);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+  })();
 </script>
+<!-- End Matomo Code -->
 <% end %>

data/lib/mitlibraries/theme/version.rb

@@ -1,5 +1,5 @@
 module Mitlibraries
   module Theme
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.3.3'.freeze
   end
 end

data/vendor/assets/stylesheets/elements/_footer.scss

@@ -7,7 +7,7 @@
 }
 
 .wrap-footer {
-    background: $black image-url("vi-shape7-tp.svg") no-repeat 10% center;
+    background: $black image-url('vi-shape7-tp.svg') no-repeat 10% center;
 
   a {
     @extend %link;
@@ -61,7 +61,7 @@
       background: $white none repeat scroll 0 0;
 
       path {
-        fill: $gray-d1;
+        fill: $gray-d1;      
       }
     }
   }

data/vendor/assets/stylesheets/elements/_header.scss

@@ -26,7 +26,7 @@
 }
 
 .wrap-header {
-  background: $black image-url("vi-shape7-tp.svg") no-repeat 0 65%;
+  background: $black image-url('vi-shape7-tp.svg') no-repeat 0 65%;
 
   .logo-mit-lib {
     display: inline-block;
@@ -90,3 +90,4 @@
   padding-top: 7px;
   padding-bottom: 5px;
 }
+

data/vendor/assets/stylesheets/global/_base.scss

@@ -60,4 +60,8 @@ a {
   background: -webkit-linear-gradient(45deg, #f23074 0%,#d6d628 36%,#207cca 66%,#544b8c 100%); /* Chrome10-25,Safari5.1-6 */
   background: linear-gradient(45deg, #f23074 0%,#d6d628 36%,#207cca 66%,#544b8c 100%); /* W3C, IE10+, FF16+, Chrome26+, Opera12+, Safari7+ */
   filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f23074', endColorstr='#544b8c',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */
+
+  .wrap-header {
+    background: transparent;
+  }
 }

data/vendor/assets/stylesheets/global/_variables.scss

@@ -87,8 +87,8 @@ $fs-smallish: 1.3rem;
 $fs-small: 1.4rem;
 $fs-base: 1.6rem;
 $fs-large: 2.0rem;
-$fs-xlarge: 2.8rem;
-$fs-xxlarge: 3.6rem;
+$fs-xlarge: 2.6rem;
+$fs-xxlarge: 3.2rem;
 $fs-xxxlarge: 4.2rem;
 $fs-xxxxlarge: 4.8rem;
 

data/vendor/assets/stylesheets/libraries-main.scss

@@ -1,17 +1,39 @@
 // ------------------------------
 // MIT Libraries Build Compile - LTR
-// this compile makes a plain base css that includes everything for
+// this compile makes a plain base css that includes everything for 
 // header, footer, and basic content styling across apps
 
-// +Get the core styles
+// +Base - Utilities
 // ====================
-@import 'core';
+@import 'global/unsets';
+@import 'global/variables';
+@import 'global/helpers';
 
-// +Select styles that need js
-@import 'js-elements/expand-collapse';
+// +Starter
+// ====================
+@import 'global/base';
+@import 'global/typography';
+@import 'global/layouts'; // various standard layouts
+
+// +Elements
+// ====================
+@import 'elements/content'; // general content styles
+@import 'elements/controls'; // buttons, link styles, sliders, etc.
+@import 'elements/forms';
+@import 'elements/modules'; // block level UI bits
+@import 'elements/tables';
+@import 'elements/header';
+@import 'elements/footer';
+
+// +Specific Views
+// ====================
 
-// TODO - split this into a separate compile
-// app specific styles
+// +Utility
 // ====================
-//@import 'apps/ebooks';
-//@import 'apps/quicksubmit';
+@import 'global/vendor-overrides'; // overrides to vendor-provided styling
+@import 'global/shame';     // used for any bad-form/orphaned scss
+
+
+// +Select styles that need js 
+@import 'js-elements/expand-collapse';
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mitlibraries-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Jeremy Prevost
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - app/helpers/link_helper.rb
@@ -127,7 +128,6 @@ files:
 - vendor/assets/images/favicon.ico
 - vendor/assets/images/mitlib-wordmark.svg
 - vendor/assets/images/vi-shape7-tp.svg
-- vendor/assets/stylesheets/_core.scss
 - vendor/assets/stylesheets/elements/_content.scss
 - vendor/assets/stylesheets/elements/_controls.scss
 - vendor/assets/stylesheets/elements/_footer.scss
@@ -164,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: General theme for MIT Libraries Rails apps

data/vendor/assets/stylesheets/_core.scss

@@ -1,32 +0,0 @@
-// ------------------------------
-// Core compile of MIT Libraries styles needed for all apps
-
-// +Base - Utilities
-// ====================
-@import 'global/unsets';
-@import 'global/variables';
-@import 'global/helpers';
-
-// +Starter
-// ====================
-@import 'global/base';
-@import 'global/typography';
-@import 'global/layouts'; // various standard layouts
-
-// +Elements
-// ====================
-@import 'elements/content'; // general content styles
-@import 'elements/controls'; // buttons, link styles, sliders, etc.
-@import 'elements/forms';
-@import 'elements/modules'; // block level UI bits
-@import 'elements/tables';
-@import 'elements/header';
-@import 'elements/footer';
-
-// +Specific Views
-// ====================
-
-// +Utility
-// ====================
-@import 'global/vendor-overrides'; // overrides to vendor-provided styling
-@import 'global/shame';     // used for any bad-form/orphaned scss