bootstrap_bux 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88f0d2e3bf57dcf8994af73df1a75e66951c8695d694ee15bfab80ee9169c833
-  data.tar.gz: 0234075f65a0bb8b1f30d0f068d528a961db8dbe9c9a86c9d39eeccad1be857d
+  metadata.gz: d654d205e3654267d752e00d8ec253382eebc7e655fa80a253d3b91b61453f4e
+  data.tar.gz: bdc356da60aec18c7fff2ec5c1bd326862a423c4993c41dec275de1fce54d74c
 SHA512:
-  metadata.gz: 180d68e0539068aeecea9abfdb7d494ed0507b3ec667ccc562c1f7286a80c9e0820d51a2d9bef39583abb7fa0d7b890b3e08f7946c324915f659b66f1c78f66b
-  data.tar.gz: 2dd9090b2989e8bbc0e4dee0811eb40cdded3e52025f56cfa939db429b092745671ed25c00060232daabf84bfe337a94fd89c00b3f7e4736ce8c7cb48ba853da
+  metadata.gz: c8cbe4f0ea92f7f2b50a26f9dbb1f4756ed0d52558e00ff7920d28409df4ff3ab213471d30d34daa450d24a9cc85d998a3578aed44fd95fe8ad9bb9063d13bc3
+  data.tar.gz: 2b0af35300726eb91d6f859e9cdf1d868b20b51a0b22e91584b78faf8d65b559bf6bb1bd137946898e2deac53de5aba68cd9e05d304e8cd363c2b315991a7f00

data/README.md

@@ -1,22 +1,65 @@
 # BootstrapBux
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bootstrap_bux`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Bootstrap Bux is a Rails-y way of including the mandatory OSU headers and footers to any website, using the basic BUX color scheme and fonts, while still allowing you to use the Bootstrap (5.3+) framework.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+To use this gem, you must first add Bootstrap (v. 5 or later) to your Gemfile, following the instructions at https://rubygems.org/gems/bootstrap 
+
+Add the bootstrap_bux gem to the application's Gemfile:
 
-    $ bundle add bootstrap_bux
+    gem bootstrap_bux
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+and then
 
-    $ gem install bootstrap_bux
+    $ bundle install
 
 ## Usage
 
-TODO: Write usage instructions here
+Once the gem is installed, place a configuration file at `config/initializers/bootstrap_bux.rb` with the following contents:
+
+    BootstrapBux.configure do |config|
+      # update these configuration options with your actual departmental info
+      config.department_name = "My Office"
+      config.building_room = "100 Building Name"
+      config.address = "1 Oval Mall"
+      config.email = "email@osu.edu"
+      config.phone = "614-292-OHIO"
+      config.fax = "614-555-5555"
+
+      # only add urls for these if your application/lab/department actually has a presence on the platform
+      config.facebook = nil
+      config.twitter = nil
+      config.instagram = nil
+      config.linkedin = nil
+      config.youtube = nil
+      config.tiktok = nil
+    end
+
+
+Editing the options in this file will allow you to change the contents of the footer to reflect actual departmental info. Note that if you do not enter URLs for the social media sites those items will be omitted from the footer, but you must include values for all other contact attributes.
+
+Within your Rails application, rendering headers and footers is simple.
+
+In your CSS/SCSS file:
+
+    @import "bootstrap_bux/application";
+
+In your view (most likely in the application layout):
+
+    = render 'bootstrap_bux/osu_header'
+
+and
+
+    = render 'bootstrap_bux/osu_header_dark'
+
+or
+
+    = render 'bootstrap_bux/osu_header_light'
+
+or
+
+    = render 'bootstrap_bux/osu_header_white'
 
 ## Development
 
@@ -26,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bootstrap_bux. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/bootstrap_bux/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://code.osu.edu/asctech/bootstrap_bux_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://code.osu.edu/asctech/bootstrap_bux_gem/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,4 +77,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the BootstrapBux project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bootstrap_bux/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the BootstrapBux project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://code.osu.edu/asctech/bootstrap_bux_gem/blob/main/CODE_OF_CONDUCT.md).

data/app/assets/stylesheets/bootstrap_bux/application.css

@@ -4,7 +4,6 @@
 @import url("https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@300;400;600");
 @import url("https://assets.bux.osu.edu/bux-icons/bux-icons.css");
 @import url("https://s3.amazonaws.com/assets.bux.osu.edu/bux-webfonts2/bux-webfonts2.css");
-@import "bootstrap";
 
 /* general body and link style */
 

data/lib/bootstrap_bux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BootstrapBux
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_bux
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Alison Furlong
@@ -10,26 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bootstrap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -56,34 +36,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 3.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
-  name: importmap-rails
+  name: bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :runtime
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement