magrathea 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57fd67de0fcd34e09f496ee3076a08ce3ff7d6fd54a0251ac3897593ddcf0147
+  data.tar.gz: 4f8ad9b036e35bbb78271a923c76ab666010839650e374a3b6f1491921c5ee63
+SHA512:
+  metadata.gz: daa143c17db37b12d0e1ccc97f0b574edee5bc62a743f65d66de53806eaa1c2abf74a5dd046768db93ce30f2e3a451ee378c10e522a010836883a982d18131b3
+  data.tar.gz: bae262b2c12ba39d5e72d32476583d0f7349557ba35cf5f0d8e7d78a1ccfacb9b4c8a9b6ad0faf0db9667a9dcc171da5106fd92bb1ac6da0db37841f48402191

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at erikyuzwa@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in magrathea.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 erik yuzwa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Magrathea
+
+This is intended to be a drop-in starting point for handling light and dark mode CSS switching in your Rails app.
+
+I've come from supporting many web applications, each with various "evolutions" of their CSS / SCSS structure. It
+remains to be seen how effective this approach is, but I was hoping to have something of a "starting point" that I could
+bring to projects and/or could be used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magrathea'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install magrathea
+
+## Usage
+
+In `application.css` add:
+```
+    *= require magrathea
+```
+
+In `application.js` add:
+```
+    //= require magrathea
+```
+
+Somewhere in your markup, you'll need to add the switch code as well:
+```
+    <div class="magrathea-switch-wrapper">
+        <label class="magrathea-switch" for="checkbox">
+            <input type="checkbox" id="checkbox" />
+            <div class="slider round"></div>
+        </label>
+        <em>Enable Dark Mode!</em>
+    </div> 
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/erikyuzwa/magrathea. 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/erikyuzwa/magrathea/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Magrathea project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/erikyuzwa/magrathea/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/lib/magrathea.rb

@@ -0,0 +1,7 @@
+require "magrathea/version"
+
+module Magrathea
+  class Error < StandardError; end
+
+  class Engine < ::Rails::Engine; end
+end

data/lib/magrathea/version.rb

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

data/magrathea.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/magrathea/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magrathea"
+  spec.version       = Magrathea::VERSION
+  spec.authors       = ["erik yuzwa"]
+  spec.email         = ["erikyuzwa@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  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["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."
+
+  # 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
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # dependencies to ensure that our SCSS is recognized
+  spec.add_dependency "sass-rails", "~> 6.0"
+end

data/vendor/assets/javascripts/magrathea.js

@@ -0,0 +1,37 @@
+//
+// 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.
+//
+
+(function() {
+
+    var win = this;
+    win.onload = function() {
+
+        const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
+
+        function switchTheme(e) {
+            if (e.target.checked) {
+                document.documentElement.setAttribute('data-theme', 'dark');
+                localStorage.setItem('theme', 'dark'); //add this
+            } else {
+                document.documentElement.setAttribute('data-theme', 'light');
+                localStorage.setItem('theme', 'light'); //add this
+            }
+        }
+
+        toggleSwitch.addEventListener('change', switchTheme, false);
+
+        const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
+
+        if (currentTheme) {
+            document.documentElement.setAttribute('data-theme', currentTheme);
+
+            if (currentTheme === 'dark') {
+                toggleSwitch.checked = true;
+            }
+        }
+    };
+
+}).call(this);
+

data/vendor/assets/stylesheets/_colors.scss

@@ -0,0 +1,16 @@
+//
+// 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.
+//
+$light-primary-color: #302ae6;
+$light-secondary-color: #536390;
+$light-font-color: #424242;
+$light-bg-color: #fff;
+$light-heading-color: #292922;
+
+$dark-primary-color: #9a97f3;
+$dark-secondary-color: #818cab;
+$dark-font-color: #e1e1ff;
+$dark-bg-color: #161625;
+$dark-heading-color: #818cab;
+

data/vendor/assets/stylesheets/_dark.scss

@@ -0,0 +1,11 @@
+//
+// 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.
+//
+[data-theme="dark"] {
+  --primary-color: $dark-primary-color;
+  --secondary-color: $dark-secondary-color;
+  --font-color: $dark-font-color;
+  --bg-color: $dark-bg-color;
+  --heading-color: $dark-heading-color;
+}

data/vendor/assets/stylesheets/_light.scss

@@ -0,0 +1,11 @@
+//
+// 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.
+//
+:root {
+  --primary-color: $light-primary-color;
+  --secondary-color: $light-secondary-color;
+  --font-color: $light-font-color;
+  --bg-color: $light-bg-color;
+  --heading-color: $light-heading-color;
+}

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

@@ -0,0 +1,67 @@
+//
+// 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
+ */
+
+.theme-switch-wrapper {
+  display: flex;
+  align-items: center;
+
+  em {
+    margin-left: 10px;
+    font-size: 1rem;
+  }
+
+  .theme-switch {
+    display: inline-block;
+    height: 34px;
+    position: relative;
+    width: 60px;
+  }
+
+  .theme-switch input {
+    display:none;
+  }
+
+  .slider {
+    background-color: #ccc;
+    bottom: 0;
+    cursor: pointer;
+    left: 0;
+    position: absolute;
+    right: 0;
+    top: 0;
+    transition: .4s;
+  }
+
+  .slider:before {
+    background-color: #fff;
+    bottom: 4px;
+    content: "";
+    height: 26px;
+    left: 4px;
+    position: absolute;
+    transition: .4s;
+    width: 26px;
+  }
+
+  input:checked + .slider {
+    background-color: #66bb6a;
+  }
+
+  input:checked + .slider:before {
+    transform: translateX(26px);
+  }
+
+  .slider.round {
+    border-radius: 34px;
+  }
+
+  .slider.round:before {
+    border-radius: 50%;
+  }
+
+}

data/vendor/assets/stylesheets/_typography.scss

@@ -0,0 +1,16 @@
+//
+// 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.
+//
+body {
+  background-color: var(--bg-color);
+  color: var(--font-color);
+}
+
+h1 {
+  color: var(--secondary-color);
+}
+
+a {
+  color: var(--primary-color);
+}

data/vendor/assets/stylesheets/magrathea.scss

@@ -0,0 +1,13 @@
+//
+// 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.
+//
+// See the README.md file for detailed installation instructions
+
+@import "colors";
+@import "light";
+@import "dark";
+@import "typography";
+
+@import "theme-switch";
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: magrathea
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- erik yuzwa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Write a longer description or delete this line.
+email:
+- erikyuzwa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/magrathea.rb
+- lib/magrathea/version.rb
+- magrathea.gemspec
+- 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
+homepage: https://github.com/erikyuzwa/magrathea
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []