Gem setup

Author: blocknotes

.gitignore

@@ -1,9 +1,19 @@
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/db/*.sqlite3-journal
-test/dummy/db/*.sqlite3-*
-test/dummy/log/*.log
-test/dummy/storage/
-test/dummy/tmp/
+*.gem
+*.orig
+
+/.rspec_failures
+/.rubocop-*
+/Gemfile.lock
+
+/_misc/
+/coverage/
+
+/.bundle/
+/log/*.log
+/pkg/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-journal
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/

.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+AllCops:
+  Exclude:
+    - bin/*
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

Gemfile

@@ -1,15 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Declare your gem's dependencies in administrate-materialize-theme.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use a debugger
-# gem 'byebug', group: [:development, :test]

README.md

@@ -1,28 +1,49 @@
-# Administrate::Materialize::Theme
-Short description and motivation.
+# Administrate Materialize Theme
+A Material theme form [Administrate](https://github.com/thoughtbot/administrate), based on [Materialize](https://materializecss.com) framework.
 
-## Usage
-How to use my plugin.
+Features:
+- Material design responsive theme;
+- customizable using SASS variables;
+- allow to use *Materialize* in the admin.
+
+![screenshot](screenshot.png)
 
 ## Installation
-Add this line to your application's Gemfile:
+- If not already installed Administrate, set it up
+- Add to *Gemfile*: `gem 'administrate-materialize-theme'` (and execute `bundle`)
+- Edit *app/assets/config/manifest.js*, adding at the end:
 
-```ruby
-gem 'administrate-materialize-theme'
+```js
+//= link administrate-materialize-theme/theme.css
+//= link administrate-materialize-theme/theme.js
 ```
 
-And then execute:
-```bash
-$ bundle
+- Edit *app/views/layouts/admin/application.html.erb* (you can generate it using `rails generate administrate:views:layout`), adding before head closing tag:
+
+```html
+<%= stylesheet_link_tag 'administrate-materialize-theme/theme', media: 'all' %>
+<%= javascript_include_tag 'administrate-materialize-theme/theme' %>
 ```
 
-Or install it yourself as:
-```bash
-$ gem install administrate-materialize-theme
+## Customizations
+To change Materialize variables it's necessary to create a new *.scss* (or *.sass*) file like this one (ex. *admin.scss*):
+
+```scss
+// app/assets/stylesheets/admin.scss
+$primary-color: #FB1;
+@import 'administrate-materialize-theme/theme';
 ```
 
-## Contributing
-Contribution directions go here.
+And replace the link tag in the *application.html.erb* with: `<%= stylesheet_link_tag 'admin', media: 'all' %>`
+
+For the complete list of options take a look [here](app/assets/stylesheets/administrate-materialize-theme/components/_variables.scss).
+
+## Do you like it? Star it!
+If you use this component just star it. A developer is more motivated to improve a project when there
+ is some interest.
+
+## Contributors
+- [Mattia Roccoberton](https://blocknot.es/): author
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Rakefile

@@ -1,32 +1 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Administrate::Materialize::Theme'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+# frozen_string_literal: true

administrate-materialize-theme.gemspec

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 $:.push File.expand_path("lib", __dir__)
 
 # Maintain your gem's version:
-require "administrate/materialize/theme/version"
+require "administrate-materialize-theme/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
   spec.name        = "administrate-materialize-theme"
-  spec.version     = Administrate::Materialize::Theme::VERSION
+  spec.version     = AdministrateMaterializeTheme::VERSION
   spec.authors     = ["Mattia Roccoberton"]
   spec.email       = ["mat@blocknot.es"]
-  spec.homepage    = "TODO"
-  spec.summary     = "TODO: Summary of Administrate::Materialize::Theme."
-  spec.description = "TODO: Description of Administrate::Materialize::Theme."
+  spec.homepage    = "https://blocknot.es"
+  spec.summary     = "Administrate Materialize Theme"
+  spec.description = "A Material theme for Administrate based on Materialize framework"
   spec.license     = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
   end
 
-  spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+  spec.files = Dir["{app,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
 
-  spec.add_dependency "rails", "~> 6.0.3", ">= 6.0.3.2"
+  spec.add_dependency 'administrate', '~> 0.14.0'
 
-  spec.add_development_dependency "sqlite3"
+  spec.add_dependency 'rubocop', '~> 0.89.1'
 end

bin/rails

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

bin/rubocop

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'administrate-materialize-theme/engine'
+
+module AdministrateMaterializeTheme
+end