magrathea 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57fd67de0fcd34e09f496ee3076a08ce3ff7d6fd54a0251ac3897593ddcf0147
-  data.tar.gz: 4f8ad9b036e35bbb78271a923c76ab666010839650e374a3b6f1491921c5ee63
+  metadata.gz: 1be538a37f89b6e665df7047a3dbc2d7ddab18f960d3e41ce2523586cd8bf1c5
+  data.tar.gz: c6e42736487e718977dc52f98258f771b318ce86551b8be7248594772bd82ab8
 SHA512:
-  metadata.gz: daa143c17db37b12d0e1ccc97f0b574edee5bc62a743f65d66de53806eaa1c2abf74a5dd046768db93ce30f2e3a451ee378c10e522a010836883a982d18131b3
-  data.tar.gz: bae262b2c12ba39d5e72d32476583d0f7349557ba35cf5f0d8e7d78a1ccfacb9b4c8a9b6ad0faf0db9667a9dcc171da5106fd92bb1ac6da0db37841f48402191
+  metadata.gz: 8bd024fba65be90dcaa57769bb4f16755a170388c3bc5fec6cf5ffde54406f634bf953423030ddfaec1ef097e5e53ea3d4b4c03da79b3d39c35b48f3cfc1dde1
+  data.tar.gz: a7a2fec02e46f4fb68b70ca28cb6dd6431544dc7e0a345e4a8257aaa3b501cd3c59c8d7b317ce98ae1cc0a79b0a528bae600799c18572b472145a2c48a56b696

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+---
+## 0.2.0
+### Added
+- Updated typography styles to aim for a first "set" of HTML element support
+- Updated a lot of documentation for this project
+- Added this changelog bro
+
+---
+## 0.1.0
+### Added
+- Went through initial gem template setup
+- Added some initial JS and markup for a "theme switch" component
+- Pushed to prod!
+
+---

data/README.md

@@ -34,7 +34,7 @@ In `application.js` add:
     //= require magrathea
 ```
 
-Somewhere in your markup, you'll need to add the switch code as well:
+Somewhere in an app view, you'll need to add the markup for the switch code as well:
 ```
     <div class="magrathea-switch-wrapper">
         <label class="magrathea-switch" for="checkbox">
@@ -45,7 +45,6 @@ Somewhere in your markup, you'll need to add the switch code as well:
     </div> 
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also

data/lib/magrathea/version.rb

@@ -1,3 +1,3 @@
 module Magrathea
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/magrathea.gemspec

@@ -4,25 +4,28 @@ Gem::Specification.new do |spec|
   spec.name          = "magrathea"
   spec.version       = Magrathea::VERSION
   spec.authors       = ["erik yuzwa"]
-  spec.email         = ["erikyuzwa@gmail.com"]
+  spec.email         = ["wazoo@hey.com"]
 
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
+  spec.summary       = %q{Get the conversation started to use a dark-light theme structure with your CSS.}
+  spec.description   = %q{Start the conversation in your project to use a dark-light theme structure with your CSS. The aim is NOT trying to come up with a drop-in replacement for every current / legacy Rails project out there.}
   spec.homepage      = "https://github.com/erikyuzwa/magrathea"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  #spec.metadata["homepage_uri"] = spec.homepage
-  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/erikyuzwa/magrathea"
+  spec.metadata["changelog_uri"] = "https://github.com/erikyuzwa/magrathea/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  # TODO: the following was generated but didn't work when I ran gem build
+  # spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  #  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # end
+  spec.files = %w[Gemfile CHANGELOG.md CODE_OF_CONDUCT.md LICENSE.txt Rakefile README.md magrathea.gemspec lib/magrathea/version.rb lib/magrathea.rb vendor/assets/javascripts/magrathea.js vendor/assets/stylesheets/_colors.scss vendor/assets/stylesheets/_dark.scss vendor/assets/stylesheets/_light.scss vendor/assets/stylesheets/_theme-switch.scss vendor/assets/stylesheets/_typography.scss vendor/assets/stylesheets/magrathea.scss]
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/vendor/assets/javascripts/magrathea.js

@@ -3,6 +3,8 @@
 // Licensed under the MIT license. See LICENSE.txt file in the project root for details.
 //
 
+// TODO: figure out how to export this for rails6 webpacker usage
+// keep this simple as we can without any dependencies
 (function() {
 
     var win = this;
@@ -10,13 +12,14 @@
 
         const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
 
+        // TODO: lots more error handling around localStorage needed even in 2020
         function switchTheme(e) {
             if (e.target.checked) {
                 document.documentElement.setAttribute('data-theme', 'dark');
-                localStorage.setItem('theme', 'dark'); //add this
+                localStorage.setItem('theme', 'dark');
             } else {
                 document.documentElement.setAttribute('data-theme', 'light');
-                localStorage.setItem('theme', 'light'); //add this
+                localStorage.setItem('theme', 'light');
             }
         }
 

data/vendor/assets/stylesheets/_colors.scss

@@ -2,6 +2,10 @@
 // Copyright (c) Erik Yuzwa of Wazoo Media. All rights reserved.
 // Licensed under the MIT license. See LICENSE.txt file in the project root for details.
 //
+
+// TODO: put in some real color palette work here, then use them as variables for variables
+
+
 $light-primary-color: #302ae6;
 $light-secondary-color: #536390;
 $light-font-color: #424242;

data/vendor/assets/stylesheets/_theme-switch.scss

@@ -2,9 +2,7 @@
 // Copyright (c) Erik Yuzwa of Wazoo Media. All rights reserved.
 // Licensed under the MIT license. See LICENSE.txt file in the project root for details.
 //
-/**
- * some simple CSS to style the dark-light theme switch
- */
+// TODO: these styles need a lot of improving -- maybe even removal? Just allow for our JS to tap into a checkbox event?
 
 .theme-switch-wrapper {
   display: flex;

data/vendor/assets/stylesheets/_typography.scss

@@ -7,10 +7,16 @@ body {
   color: var(--font-color);
 }
 
-h1 {
+h1, h3, h5 {
+  color: var(--primary-color);
+}
+
+h2, h4, h6 {
   color: var(--secondary-color);
 }
 
 a {
   color: var(--primary-color);
 }
+
+

data/vendor/assets/stylesheets/magrathea.scss

@@ -9,5 +9,6 @@
 @import "dark";
 @import "typography";
 
+// TODO: figure out a way to make this optional? A LOT of projects using this gem will have their own styles
 @import "theme-switch";
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magrathea
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - erik yuzwa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass-rails
@@ -24,23 +24,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-description: Write a longer description or delete this line.
+description: Start the conversation in your project to use a dark-light theme structure
+  with your CSS. The aim is NOT trying to come up with a drop-in replacement for every
+  current / legacy Rails project out there.
 email:
-- erikyuzwa@gmail.com
+- wazoo@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/magrathea.rb
 - lib/magrathea/version.rb
 - magrathea.gemspec
@@ -54,7 +52,10 @@ files:
 homepage: https://github.com/erikyuzwa/magrathea
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/erikyuzwa/magrathea
+  source_code_uri: https://github.com/erikyuzwa/magrathea
+  changelog_uri: https://github.com/erikyuzwa/magrathea/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -74,5 +75,6 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Get the conversation started to use a dark-light theme structure with your
+  CSS.
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.idea/

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.8
-before_install: gem install bundler -v 2.1.4

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "magrathea"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here