devise_materialize 0.0.4.test3 → 0.0.5.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d9abb8acd03565d958bf1389a643aeef92a6757
-  data.tar.gz: 39891493cea1b9498710426c5a0516720de91c78
+  metadata.gz: 70fb15b8ae846f427cd583a498f91703e0014b87
+  data.tar.gz: 49ad450160eee861edd0523072cc5600881e1f56
 SHA512:
-  metadata.gz: 9247169c99e0e1d9eaab559c095ab3f10ecbafbbd2d0f03261d783a2eecb18dd60f4726b1bade9adb9a0188d9012dee6555bd942f58e780a2d62a19fc83b6d8c
-  data.tar.gz: 67233fc1d239992a4ddf0bed0a754b34950163123c6e420c884ca05ff3f52bf534ef7b1a0d01fcc965080a7f34f9a429978491ddbffb8ed7a0cf6ca2c034a6c4
+  metadata.gz: bfce59a98a2725110961c881a9fdfaf78d86671f7bd0116635a42240746f9d57ca56a0b00fee66241da3a7d41fa571b30bb2413420608727de83641e592dafc8
+  data.tar.gz: 27ce61743bd08ac9d55af5569e7f39f71f989a58b64e79ee0ef29cba1efe3b24c916eb8fd2a9e3ad024403fe6d7235099f4e97d7f4a0a3587da587aa79a9345a

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- vendor/
+- test/rails_app
+- lib/generators/templates

data/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/test/reports/
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -48,3 +49,7 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+
+# Linter outputs
+rubocop-results.html

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   - Gemfile.lock
   - devise_materialize.gemspec
   - Rakefile
+  - test/rails_app/**/*
   TargetRubyVersion: 2.4
 Lint/AmbiguousOperator:
   Description: Checks for ambiguous operators in the first argument of a method invocation
@@ -156,6 +157,8 @@ Metrics/AbcSize:
   Reference: http://c2.com/cgi/wiki?AbcMetric
   Enabled: true
   Max: 15
+  Exclude:
+    - test/lib/install_generator_test.rb
 Metrics/BlockNesting:
   Description: Avoid excessive block nesting
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count
@@ -178,6 +181,8 @@ Metrics/MethodLength:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
   Enabled: true
   Max: 10
+  Exclude:
+    - test/lib/install_generator_test.rb
 Metrics/ModuleLength:
   Description: Avoid modules longer than 100 lines of code.
   Enabled: true

data/.yardopts

@@ -0,0 +1 @@
+--exclude /templates/

data/Gemfile

@@ -2,3 +2,13 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "minitest-ci"
+gem "rails", "~> 5.0.0"
+gem "rubocop"
+gem "simplecov"
+gem "yard"
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    devise_materialize (0.0.4.test3)
-      rails (~> 5.0.1)
+    devise_materialize (0.0.5.alpha)
+      railties (>= 4.1.0, < 5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -45,13 +45,17 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (7.1.4)
+    ast (2.3.0)
     builder (3.2.3)
-    coderay (1.1.1)
+    codeclimate-test-reporter (1.0.5)
+      simplecov
     concurrent-ruby (1.0.4)
+    docile (1.1.5)
     erubis (2.7.0)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.8.0)
+    json (2.0.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -62,13 +66,14 @@ GEM
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
+    minitest-ci (3.1.0)
+      minitest (~> 5.0, >= 5.0.6)
     nio4r (1.2.1)
     nokogiri (1.7.0.1)
       mini_portile2 (~> 2.1.0)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -95,8 +100,20 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.1)
     rake (10.5.0)
-    slop (3.6.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -108,19 +125,23 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unicode-display_width (1.1.3)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
+    yard (0.9.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.13)
+  codeclimate-test-reporter
   devise_materialize!
-  minitest (~> 5.0)
-  pry (~> 0.10.4)
-  rake (~> 10.0)
+  minitest-ci
+  rails (~> 5.0.0)
+  rubocop
+  simplecov
+  yard
 
 BUNDLED WITH
    1.13.7

data/README.md

@@ -1,39 +1,79 @@
-# DeviseMaterialize
+# Devise
 
-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/devise_materialize`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem](https://img.shields.io/gem/v/devise_materialize.svg?style=flat-square)](https://rubygems.org/gems/devise_materialize)
+[![CircleCI](https://img.shields.io/circleci/project/github/techgurupezza/devise_materialize.svg?style=flat-square)](https://circleci.com/gh/techgurupezza/devise_materialize)
+[![Code Climate](https://img.shields.io/codeclimate/github/techgurupezza/devise_materialize.svg?style=flat-square)](https://lima.codeclimate.com/github/techgurupezza/devise_materialize)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/techgurupezza/devise_materialize.svg?style=flat-square)](https://lima.codeclimate.com/github/techgurupezza/devise_materialize/coverage)
+[![Gemnasium](https://img.shields.io/gemnasium/techgurupezza/devise_materialize.svg?style=flat-square)](https://gemnasium.com/github.com/techgurupezza/devise_materialize)
+[![Gem](https://img.shields.io/gem/dt/devise_materialize.svg?style=flat-square)](https://rubygems.org/gems/devise_materialize)
 
-TODO: Delete this and the text above, and describe your gem
+
+Devise Materialize gem is here to generate you devise view in a materialize styled format with or w/o simple_form.
+This gem is not intended to live forever in your gemfile. It must be in your gemfile to load the resources needed from the generator.
+Below in the installation section will detail out which gems to install for all to work.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
 ```ruby
-gem 'devise_materialize'
-```
+# Required gems so you don't have to add files manually
+gem "devise"
+gem "materialize-sass"
+gem "material_icons"
 
-And then execute:
+# Required if using HAML
+gem "haml"
 
-    $ bundle install
+# Required if using Slim
+gem "slim"
 
-Or install it yourself as:
+# Required if using Simple Form
+gem "simple_form"
 
-    $ gem install devise_materialize
+gem "devise_materialize", "~>1.0.0"
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+[devise](https://github.com/plataformatec/devise), [materialize-sass](https://github.com/mkhairi/materialize-sass) and [material_icons](https://github.com/Angelmmiguel/material_icons) are required in your gemfile to enable the views to generate without error and in the proper style.
+
+| Command Line Flags      | Description                            | Defaults | Options                  |
+| ----------------------- | -------------------------------------- | -------- | ------------------------ |
+| NAMESPACE               | What is the model name used for devise | Devise   | Devise, Users, Admins, etc |
+| -f / --form-engine      | Define a form Engine to use            | default  | default, simple_form     |
+| -v / --view-engine      | Define a View Engine to use            | erb      | erb, haml, slim          |
+
+### Basic Usage
+
+```bash
+$ rails g devise_materialize:install
+```
+This will generate the basic views of devise based on defaults
+
+### Parameters Defined
+
+If you plan to use simple form using this gem [simple_form_materialize](https://github.com/techgurupezza/simple_form_materialize) to install a config file with all wrappers defined as used in this gem.
+
+```bash
+$ rails g devise_materialize:install Users --form-engine simple_form --view-engine haml
+```
+This will generate the views in simple form usage and HAML syntax
 
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake build`. 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/techgurupezza/devise_materialize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+1. Fork Repo and create new branch
+2. Once all is changed and committed create a pull request.
+
+**Ensure all merge conflicts are fixed and CI is passing.**
 
 ## License
 

data/Rakefile

@@ -1,5 +1,10 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
+
+if ENV['CIRCLECI']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'linters')
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +12,20 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+desc 'Rubocop Task'
+task (:rubocop) do
+  outputpath =
+    if ENV['CIRCLECI']
+      "#{dir}/rubocop-results.html"
+    else
+      'rubocop-results.html'
+    end
+  RuboCop::RakeTask.new do |t|
+    t.options = [
+      '-c', '.rubocop.yml', '-D', '-f', 'html', '-o', outputpath,
+    ]
+    t.fail_on_error = true
+  end
+end
+
 task default: :test

data/circle.yml

@@ -0,0 +1,21 @@
+machine:
+  timezone: America/New_York
+  ruby:
+    version: 2.4.0
+
+dependencies:
+  pre:
+    - gem update --system
+    - gem install rainbow -v "2.2.1"
+    - gem install bundler
+
+test:
+  override:
+    - bundle exec rake test:
+        parallel: true
+        files:
+          - test/**/*_test.rb
+
+  post:
+    - bundle exec codeclimate-test-reporter
+    - bundle exec rake rubocop

data/devise_materialize.gemspec

@@ -7,6 +7,7 @@ require "devise_materialize/version"
 Gem::Specification.new do |spec|
   spec.name          = "devise_materialize"
   spec.version       = DeviseMaterialize::VERSION
+  spec.platform      = Gem::Platform::RUBY
   spec.authors       = ["Christopher Pezza"]
   spec.email         = ["pezza.chris@gmail.com"]
 
@@ -17,25 +18,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/techgurupezza/devise_materialize"
   spec.license       = "MIT"
 
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-          "public gem pushes."
-  end
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "~>5.0.1"
+  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_rubygems_version = "> 1.3.1"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_dependency("railties", ">= 4.1.0", "< 5.1")
 end

data/lib/devise_materialize/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DeviseMaterialize
-  VERSION = "0.0.4.test3"
+  VERSION = "0.0.5.alpha"
 end

data/lib/generators/devise_materialize/install_generator.rb

@@ -1,46 +1,32 @@
 # frozen_string_literal: true
+require "rails/generators"
+
 module DeviseMaterialize
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("../../templates", __FILE__)
 
     desc "Creates a Devise Materialize Styled Views"
-    argument :namespace, type: :string, defualt: "Users"
-    class_option :simple_form, type: :boolean, default: false, alias: "-s",
-                               description: "Define if simple form is used " \
-                               "to load views built with simple form"
-    class_option :template_engine, type: :string, default: "erb", alias: "-e",
-                                   description: "Choose a template engine " \
-                                   "from erb, haml, or slim"
+    argument :namespace, type: :string, default: "Devise"
+    class_option :form_engine, type: :string, default: "default", aliases: "-f"
+    class_option :view_engine, type: :string, default: "erb", aliases: "-v"
 
     def generate_views
-      if options.simple_form
-        simple_form_views(options.template_engine.downcase)
-      else
-        default_views(options.template_engine.downcase)
-      end
+      puts "Generating Views..."
+      directory "#{options.view_engine.downcase}/#{options.form_engine}",
+                "app/views/#{file_name}"
+      puts "Generating Stylesheet..."
+      directory "assets", "app/assets/"
+      puts "Generating Devise Helper..."
+      directory "helpers", "app/helpers"
     end
 
     private
 
-    def simple_form_views(data)
-      case data
-      when "erb"
-        directory "erb/simple_form", "app/views/#{namespace.downcase}"
-      when "haml"
-        directory "haml/simple_form", "app/views/#{namespace.downcase}"
-      when "slim"
-        directory "slim/simple_form", "app/views/#{namespace.downcase}"
-      end
-    end
-
-    def default_views(data)
-      case data
-      when "erb"
-        directory "erb/defaults", "app/views/#{namespace.downcase}"
-      when "haml"
-        directory "haml/defaults", "app/views/#{namespace.downcase}"
-      when "slim"
-        directory "slim/defaults", "app/views/#{namespace.downcase}"
+    def file_name
+      if namespace.casecmp("devise").zero?
+        namespace.downcase.underscore
+      else
+        namespace.downcase.underscore.pluralize
       end
     end
   end