archangel 0.3.0 → 0.4.0

data/docs/Developers.md

@@ -35,15 +35,15 @@ $ bundle exec rspec spec --fail-fast
 
 Various tools are used to ensure code is linted and formatted correctly.
 
-### JSHint
+### ESLint
 
-[jshint](https://github.com/jshint/jshint) is a Javascript style analyzer.
+[eslint](https://eslint.org/) is a Javascript lint and style analyzer.
 
 ```
-$ jshint app/assets
+$ eslint .
 ```
 
-> NOTE: Integrations for multiple text editors and IDEs are [also available](http://jshint.com/install/).
+> NOTE: Integrations for multiple text editors and IDEs are [also available](https://eslint.org/docs/user-guide/integrations).
 
 ### Reek
 
@@ -63,14 +63,16 @@ $ reek
 $ rubocop
 ```
 
-### scss-lint
+### Sass Lint
 
-[scss-lint](https://github.com/brigade/scss-lint) is a SCSS style analyzer.
+[sass-lint](https://github.com/sasstools/sass-lint) is a Sass linter.
 
 ```
-$ scss-lint .
+$ sass-lint -v
 ```
 
+> NOTE: Integrations for multiple text editors and IDEs are [also available](https://github.com/sasstools/sass-lint#ide-integration).
+
 ## Security and Maintenance
 
 [Brakeman](https://github.com/presidentbeef/brakeman) is a static analysis security vulnerability scanner. Brakeman issues are reported in [Code Climate](https://codeclimate.com/).

data/docs/Extension/Controllers.md

@@ -114,7 +114,7 @@ Extending `BackendController` assumes your controller requires policy authorizat
 module Archangel
   module Backend
     class FoosController < BackendController
-      include Archangel::SkipAuthorizableConcern
+      include Archangel::Controllers::SkipAuthorizableConcern
 
       ...
     end

data/docs/Extension/Uploaders.md

@@ -40,7 +40,7 @@ end
 
 When no file has been uploaded, fallback images for Carrierwave will need to be provided as well as default path to the fallback images.
 
-Assuming `original`, `large`, `medium`, `small` and `tiny` as the sizes specified, the following images will need to be created; 
+Assuming `original`, `large`, `medium`, `small` and `tiny` as the sizes specified, the following images will need to be created;
 
 * `archangel/fallback/amazing.jpg`
 * `archangel/fallback/large_amazing.jpg`

data/lib/archangel.rb

@@ -11,26 +11,23 @@ require "date_validator"
 require "devise"
 require "devise_invitable"
 require "file_validators"
-require "font-awesome-rails"
+require "font-awesome-sass"
 require "jbuilder"
 require "jquery-rails"
 require "kaminari"
 require "liquid"
 require "meta-tags"
 require "mini_magick"
-require "momentjs-rails"
 require "paranoia"
-require "popper_js"
 require "pundit"
 require "responders"
-require "selectize-rails"
+require "sass-rails"
 require "simple_form"
 require "validates"
 
 require "archangel/engine"
 require "archangel/config"
 require "archangel/i18n"
-require "archangel/liquid_view"
 require "archangel/constants/language"
 require "archangel/constants/role"
 require "archangel/constants/theme"
@@ -42,14 +39,8 @@ require "archangel/liquid/tags/application_tag"
 require "archangel/liquid/tags/asset_tag"
 require "archangel/liquid/tags/collection_tag"
 require "archangel/liquid/tags/collectionfor_tag"
-require "archangel/liquid/tags/csrf_meta_tags_tag"
 require "archangel/liquid/tags/gist_tag"
-require "archangel/liquid/tags/locale_tag"
-require "archangel/liquid/tags/meta_tags_tag"
 require "archangel/liquid/tags/noembed_tag"
-require "archangel/liquid/tags/text_direction_tag"
-require "archangel/liquid/tags/theme_javascript_tag"
-require "archangel/liquid/tags/theme_stylesheet_tag"
 require "archangel/liquid/tags/vimeo_tag"
 require "archangel/liquid/tags/youtube_tag"
 require "archangel/liquid/tags/widget_tag"

data/lib/archangel/commands/base_command.rb

@@ -14,6 +14,10 @@ module Archangel
       include Thor::Actions
 
       no_tasks do
+        def class_name
+          plugin_class_name(extension_name)
+        end
+
         def plugin_class_name(plugin_name)
           Thor::Util.camel_case(plugin_name)
         end
@@ -21,14 +25,6 @@ module Archangel
         def archangel_version
           Archangel.version[/(.*)\./, 1]
         end
-
-        def random_compliment
-          [
-            "You look lovely today by the way.",
-            "I have a feeling you're about to build something amazing.",
-            "Of all the people in the world, you're my favorite."
-          ].sample
-        end
       end
     end
   end

data/lib/archangel/commands/extension_command.rb

@@ -50,9 +50,13 @@ module Archangel
       # Copy common directories that are shared with theme generator
       #
       def copy_common_directories
-        %w[spec].each do |dir|
+        %w[
+          bin lib spec
+        ].each do |dir|
           directory("../common/#{dir}", "#{extension_name}/#{dir}")
         end
+
+        chmod("#{extension_name}/bin/rails", 0o755)
       end
 
       ##
@@ -60,10 +64,8 @@ module Archangel
       #
       def copy_plugin_directories
         %w[
-          app bin config lib
+          config lib
         ].each { |dir| directory(dir, "#{extension_name}/#{dir}") }
-
-        chmod("#{extension_name}/bin/rails", 0o755)
       end
 
       ##
@@ -71,7 +73,7 @@ module Archangel
       #
       def copy_common_templates
         %w[
-          .editorconfig .gitignore .rspec .rubocop.yml MIT-LICENSE
+          .gitignore .rspec Gemfile MIT-LICENSE Rakefile
         ].each do |tpl|
           template("../common/#{tpl}", "#{extension_name}/#{tpl}")
         end
@@ -82,7 +84,7 @@ module Archangel
       #
       def copy_plugin_templates
         %w[
-          Gemfile Rakefile README.md
+          README.md
         ].each { |tpl| template(tpl, "#{extension_name}/#{tpl}") }
       end
 
@@ -92,14 +94,14 @@ module Archangel
       # Say something nice
       #
       def banner
-        puts %(
+        say %(
 
   ******************************************************************
 
     Your extension has been generated with a gemspec dependency on
-    Archangel v#{archangel_version}
+    Archangel ~> v#{archangel_version}
 
-      #{random_compliment}
+      I have a feeling you're about to build something amazing.
 
   ******************************************************************
 
@@ -107,10 +109,6 @@ module Archangel
       end
 
       no_tasks do
-        def class_name
-          plugin_class_name(extension_name)
-        end
-
         def name_plugin
           @extension_name = corrected_plugin_name
         end
@@ -118,7 +116,9 @@ module Archangel
         def corrected_plugin_name
           ext_name = extension_name.downcase
 
-          ext_name = "archangel_#{ext_name}" unless ext_name =~ /^archangel_/
+          unless /^archangel_/.match?(ext_name)
+            ext_name = "archangel_#{ext_name}"
+          end
 
           Thor::Util.snake_case(ext_name)
         end

data/lib/archangel/commands/templates/common/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rubocop", "~> 0.67", require: false
+end
+
+group :development, :test do
+  gem "pry-byebug", "~> 3.6"
+  gem "sqlite3", "~> 1.3.6"
+  gem "thor", "~> 0.20"
+end
+
+group :test do
+  # Shared, general purpose gems
+  gem "capybara", "~> 3.21"
+  gem "database_cleaner", "~> 1.7"
+  gem "factory_bot_rails", "~> 5.0"
+  gem "rspec-rails", "~> 3.8"
+  gem "shoulda-matchers", "~> 4.0"
+end

data/lib/archangel/commands/templates/{extension → common}/Rakefile

@@ -19,7 +19,7 @@ task default: :spec
 
 desc "Generates a dummy app for testing"
 task :dummy_app do
-  # ENV["DB"] = "sqlite3" # mysql, postgresql, sqlite3, etc
+  # ENV["DB"] = "sqlite3" # Options: mysql, postgresql, sqlite3
   ENV["LIB_NAME"] = "<%= extension_name %>"
 
   Rake::Task["dummy:generate"].invoke

data/lib/archangel/commands/templates/common/spec/rails_helper.rb.tt

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "simplecov"
-
-SimpleCov.start :rails
-
 ENV["RAILS_ENV"] ||= "test"
 
 begin

data/lib/archangel/commands/templates/extension/lib/generators/%extension_name%/install/install_generator.rb.tt

@@ -6,19 +6,19 @@ module <%= class_name %>
       class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_javascripts
-        %w[auth backend frontend].each do |section|
-          append_file "vendor/assets/javascripts/archangel/#{section}.js",
-                      "//= require archangel/#{section}/<%= extension_name %>\n"
-        end
+        # %w[backend].each do |section|
+        #   append_file "vendor/assets/javascripts/archangel/#{section}.js",
+        #               "//= require archangel/#{section}/<%= extension_name %>\n"
+        # end
       end
 
       def add_stylesheets
-        %w[auth backend frontend].each do |section|
-          inject_into_file "vendor/assets/stylesheets/archangel/#{section}.css",
-                           "*= require archangel/#{section}/<%= extension_name %>\n ",
-                           before: %r{\*/},
-                           verbose: true
-        end
+        # %w[backend].each do |section|
+        #   inject_into_file "vendor/assets/stylesheets/archangel/#{section}.css",
+        #                    "*= require archangel/#{section}/<%= extension_name %>\n ",
+        #                    before: %r{\*/},
+        #                    verbose: true
+        # end
       end
 
       def add_migrations

data/lib/archangel/commands/templates/theme/README.md

@@ -7,7 +7,7 @@ Introduction goes here.
 Add to your application's Gemfile
 
 ```
-gem "<%= theme_name %>", github: "USERNAME/<%= theme_name %>"
+gem "<%= extension_name %>", github: "USERNAME/<%= extension_name %>"
 ```
 
 Run the bundle command
@@ -37,7 +37,7 @@ $ bundle exec rspec spec
 
 ## Contributing
 
-1. Fork it ( https://github.com/USERNAME/<%= theme_name %>/fork )
+1. Fork it ( https://github.com/USERNAME/<%= extension_name %>/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/archangel/commands/templates/theme/app/themes/%theme_base_name%/config/locales/en.yml.tt

@@ -1,4 +1,4 @@
 en:
   archangel:
     hello: "Hello world"
-    <%= theme_name %>: <%= class_name %>
+    <%= extension_name %>: <%= class_name %>

data/lib/archangel/commands/templates/theme/app/themes/%theme_base_name%/views/layouts/frontend.html.erb

@@ -0,0 +1,20 @@
+<!doctype html>
+<html dir="<%= text_direction %>" lang="<%= locale %>">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
+
+    <%= display_meta_tags %>
+
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag "#{current_theme}/frontend", media: "all" %>
+    <%= yield(:stylesheet) if content_for?(:stylesheet) %>
+  </head>
+  <body>
+    <%= yield %>
+
+    <%= javascript_include_tag "#{current_theme}/frontend" %>
+    <%= yield(:javascript) if content_for?(:javascript) %>
+  </body>
+</html>

data/lib/archangel/commands/templates/theme/theme.gemspec.tt

@@ -2,14 +2,14 @@
 
 $LOAD_PATH.push File.expand_path("lib", __dir__)
 
-require "<%= theme_name %>/version"
+require "<%= extension_name %>/version"
 
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
-  s.name        = "<%= theme_name %>"
+  s.name        = "<%= extension_name %>"
   s.version     = <%= class_name %>::VERSION
   s.authors     = ["Your Name"]
-  s.homepage    = "https://github.com/USERNAME/<%= theme_name %>"
+  s.homepage    = "https://github.com/USERNAME/<%= extension_name %>"
   s.summary     = "TODO: Summary of <%= class_name %>."
   s.description = "TODO: Description of <%= class_name %>."
   s.license     = "MIT"

data/lib/archangel/commands/theme_command.rb

@@ -16,14 +16,16 @@ module Archangel
       source_root File.expand_path("templates/theme", __dir__)
 
       desc "Build an Archangel theme"
-      argument :theme_name, type: :string, desc: "Theme name", default: "sample"
+      argument :extension_name, type: :string,
+                                desc: "Theme name",
+                                default: "sample"
 
       ##
       # Generate theme
       #
       # Usage
-      #   archangel theme [THEME_NAME]
-      #   bundle exec bin/archangel theme [THEME_NAME]
+      #   archangel theme [EXTENSION_NAME]
+      #   bundle exec bin/archangel theme [EXTENSION_NAME]
       #
       def generate
         name_plugin
@@ -33,23 +35,27 @@ module Archangel
       # Create theme directory
       #
       def create_plugin_directory
-        empty_directory(theme_name)
+        empty_directory(extension_name)
       end
 
       ##
       # Create theme .gemspec file
       #
       def create_plugin_gemspec
-        template("theme.gemspec", "#{theme_name}/#{theme_name}.gemspec")
+        template("theme.gemspec", "#{extension_name}/#{extension_name}.gemspec")
       end
 
       ##
       # Copy common directories that are shared with extension generator
       #
       def copy_common_directories
-        %w[spec].each do |dir|
-          directory("../common/#{dir}", "#{theme_name}/#{dir}")
+        %w[
+          bin lib spec
+        ].each do |dir|
+          directory("../common/#{dir}", "#{extension_name}/#{dir}")
         end
+
+        chmod("#{extension_name}/bin/rails", 0o755)
       end
 
       ##
@@ -57,10 +63,8 @@ module Archangel
       #
       def copy_plugin_directories
         %w[
-          app bin lib
-        ].each { |dir| directory(dir, "#{theme_name}/#{dir}") }
-
-        chmod("#{theme_name}/bin/rails", 0o755)
+          app
+        ].each { |dir| directory(dir, "#{extension_name}/#{dir}") }
       end
 
       ##
@@ -68,9 +72,9 @@ module Archangel
       #
       def copy_common_templates
         %w[
-          .editorconfig .gitignore .rspec .rubocop.yml MIT-LICENSE
+          .gitignore .rspec Gemfile MIT-LICENSE Rakefile
         ].each do |tpl|
-          template("../common/#{tpl}", "#{theme_name}/#{tpl}")
+          template("../common/#{tpl}", "#{extension_name}/#{tpl}")
         end
       end
 
@@ -79,8 +83,8 @@ module Archangel
       #
       def copy_plugin_templates
         %w[
-          Gemfile Rakefile README.md
-        ].each { |tpl| template(tpl, "#{theme_name}/#{tpl}") }
+          README.md
+        ].each { |tpl| template(tpl, "#{extension_name}/#{tpl}") }
       end
 
       ##
@@ -89,14 +93,14 @@ module Archangel
       # Say something nice
       #
       def banner
-        puts %(
+        say %(
 
   ******************************************************************
 
     Your theme has been generated with a gemspec dependency on
-    Archangel v#{archangel_version}
+    Archangel ~> v#{archangel_version}
 
-      #{random_compliment}
+      You look lovely today by the way.
 
   ******************************************************************
 
@@ -104,22 +108,21 @@ module Archangel
       end
 
       no_tasks do
-        def class_name
-          plugin_class_name(theme_name)
-        end
-
         def name_plugin
-          @theme_name = corrected_plugin_name
+          @extension_name = corrected_plugin_name
         end
 
         def theme_base_name
-          theme_name.sub(/^archangel_/, "").sub(/_theme$/, "")
+          extension_name.sub(/^archangel_/, "").sub(/_theme$/, "")
         end
 
         def corrected_plugin_name
-          ext_name = theme_name.downcase
-          ext_name = "archangel_#{ext_name}" unless ext_name =~ /^archangel_/
-          ext_name = "#{ext_name}_theme" unless ext_name =~ /_theme$/
+          ext_name = extension_name.downcase
+
+          unless /^archangel_/.match?(ext_name)
+            ext_name = "archangel_#{ext_name}"
+          end
+          ext_name = "#{ext_name}_theme" unless /_theme$/.match?(ext_name)
 
           Thor::Util.snake_case(ext_name)
         end