archangel 0.0.8 → 0.3.0

data/docs/Extension/Uploaders.md

@@ -1,3 +1,55 @@
 # Uploaders
 
-TODO
+Uploaders are built on top of Carrierwave and should extend `Archangel::ApplicationUploader`.
+
+Below is a basic example of an Uploader
+
+```
+# frozen_string_literal: true
+
+module Archangel
+  class AmazingUploader < ApplicationUploader
+    version :large do
+      process resize_to_fit: [256, 256]
+    end
+
+    version :medium, from_version: :large do
+      process resize_to_fit: [128, 128]
+    end
+
+    version :small, from_version: :medium do
+      process resize_to_fit: [64, 64]
+    end
+
+    version :tiny, from_version: :small do
+      process resize_to_fit: [32, 32]
+    end
+
+    def default_path
+      "archangel/fallback/" + [version_name, "amazing.png"].compact.join("_")
+    end
+
+    def filename
+      "amazing.#{file.extension}" if original_filename.present?
+    end
+  end
+end
+```
+
+## Default Image Path
+
+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; 
+
+* `archangel/fallback/amazing.jpg`
+* `archangel/fallback/large_amazing.jpg`
+* `archangel/fallback/medium_amazing.jpg`
+* `archangel/fallback/small_amazing.jpg`
+* `archangel/fallback/tiny_amazing.jpg`
+
+These images will need to be added to the `app/assets/images/` directory. To change this path where fallback images life, override the `default_path` method.
+
+## Upload Path
+
+When `AmazingUploader` is used in the Page controller, `uploads/archangel/pages/amazing/123` will become the path for uploaded files. To change this path, override the `store_dir` method.

data/docs/Theme/Developers.md

@@ -1,7 +1,13 @@
 # Theme Developers
 
-Themes are meant to change the design of Archangel. Documentation for extension development is [also available](https://github.com/archangel/archangel/blob/master/docs/Extension/Developers.md).
+Themes are meant to change the design and UI of Archangel. Documentation for extension development is [also available](https://github.com/archangel/archangel/blob/master/docs/Extension/Developers.md).
 
 ## Generate a theme
 
-TODO
+Generate an Archangel extension with `archangel theme NAME`
+
+To generate an extension at `PWD` with the name `archangel_foo_theme`
+
+```
+$ archangel extension foo
+```

data/lib/archangel.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "activerecord-typedstore"
 require "acts_as_list"
 require "acts_as_tree"
 require "anyway_config"
@@ -22,10 +23,8 @@ require "paranoia"
 require "popper_js"
 require "pundit"
 require "responders"
-require "sass-rails"
 require "selectize-rails"
 require "simple_form"
-require "uglifier"
 require "validates"
 
 require "archangel/engine"
@@ -47,6 +46,7 @@ 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"

data/lib/archangel/commands/base_command.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Archangel
+  ##
+  # Command line
+  #
+  module Commands
+    ##
+    # Generate Archangel extension
+    #
+    class BaseCommand < Thor::Group
+      include Thor::Actions
+
+      no_tasks do
+        def plugin_class_name(plugin_name)
+          Thor::Util.camel_case(plugin_name)
+        end
+
+        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
+end

data/lib/archangel/commands/extension_command.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "thor"
+
+require "archangel/commands/base_command"
+
+module Archangel
+  ##
+  # Command line
+  #
+  module Commands
+    ##
+    # Generate Archangel extension
+    #
+    class ExtensionCommand < BaseCommand
+      source_root File.expand_path("templates/extension", __dir__)
+
+      desc "Build an Archangel extension"
+      argument :extension_name, type: :string,
+                                desc: "Extension name",
+                                default: "sample"
+
+      ##
+      # Generate extension
+      #
+      # Usage
+      #   archangel extension [EXTENSION_NAME]
+      #   bundle exec bin/archangel extension [EXTENSION_NAME]
+      #
+      def generate
+        name_plugin
+      end
+
+      ##
+      # Create extension directory
+      #
+      def create_plugin_directory
+        empty_directory(extension_name)
+      end
+
+      ##
+      # Create extension .gemspec file
+      #
+      def create_plugin_gemspec
+        template("extension.gemspec",
+                 "#{extension_name}/#{extension_name}.gemspec")
+      end
+
+      ##
+      # Copy common directories that are shared with theme generator
+      #
+      def copy_common_directories
+        %w[spec].each do |dir|
+          directory("../common/#{dir}", "#{extension_name}/#{dir}")
+        end
+      end
+
+      ##
+      # Copy extension directories and chmod bin scripts
+      #
+      def copy_plugin_directories
+        %w[
+          app bin config lib
+        ].each { |dir| directory(dir, "#{extension_name}/#{dir}") }
+
+        chmod("#{extension_name}/bin/rails", 0o755)
+      end
+
+      ##
+      # Copy common templates that are shared with theme generator
+      #
+      def copy_common_templates
+        %w[
+          .editorconfig .gitignore .rspec .rubocop.yml MIT-LICENSE
+        ].each do |tpl|
+          template("../common/#{tpl}", "#{extension_name}/#{tpl}")
+        end
+      end
+
+      ##
+      # Copy extension templates
+      #
+      def copy_plugin_templates
+        %w[
+          Gemfile Rakefile README.md
+        ].each { |tpl| template(tpl, "#{extension_name}/#{tpl}") }
+      end
+
+      ##
+      # Banner
+      #
+      # Say something nice
+      #
+      def banner
+        puts %(
+
+  ******************************************************************
+
+    Your extension has been generated with a gemspec dependency on
+    Archangel v#{archangel_version}
+
+      #{random_compliment}
+
+  ******************************************************************
+
+        )
+      end
+
+      no_tasks do
+        def class_name
+          plugin_class_name(extension_name)
+        end
+
+        def name_plugin
+          @extension_name = corrected_plugin_name
+        end
+
+        def corrected_plugin_name
+          ext_name = extension_name.downcase
+
+          ext_name = "archangel_#{ext_name}" unless ext_name =~ /^archangel_/
+
+          Thor::Util.snake_case(ext_name)
+        end
+      end
+    end
+  end
+end

data/lib/archangel/{command/templates/extension → commands/templates/common}/spec/rails_helper.rb.tt

@@ -25,9 +25,6 @@ require "rspec/rails"
 # Archangel support files
 require "archangel/testing_support/support"
 
-# Require factories defined in lib/<%= extension_name %>/factories.rb
-require "<%= extension_name %>/factories"
-
 # Local support files
 Dir[Rails.root.join("../support/**/*.rb")].each { |f| require f }
 

data/lib/archangel/{command → commands}/templates/extension/Gemfile

@@ -5,24 +5,23 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "rubocop", "~> 0.52", require: false
+  gem "rubocop", "~> 0.59", require: false
 end
 
 group :development, :test do
-  gem "pry-byebug", "~> 3.5"
+  gem "pry-byebug", "~> 3.6"
   gem "sqlite3", ">= 1.3", platforms: %i[ruby mswin mswin64 mingw x64_mingw]
-  gem "thor", "~> 0.19"
+  gem "thor", "~> 0.20"
 end
 
 group :test do
-  gem "capybara", "~> 2.17"
-  gem "database_cleaner", "~> 1.6"
-  gem "factory_bot_rails", "~> 4.8"
-  gem "launchy", "~> 2.4"
-  gem "poltergeist", "~> 1.17"
+  gem "capybara", "~> 3.8"
+  gem "database_cleaner", "~> 1.7"
+  gem "factory_bot_rails", "~> 4.11"
+  gem "poltergeist", "~> 1.18"
   gem "rails-controller-testing", "~> 1.0"
-  gem "rspec-rails", "~> 3.7"
+  gem "rspec-rails", "~> 3.8"
   gem "shoulda-callback-matchers", "~> 1.1"
   gem "shoulda-matchers", "~> 3.1"
-  gem "simplecov", "~> 0.14"
+  gem "simplecov", "~> 0.16"
 end

data/lib/archangel/commands/templates/theme/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rubocop", "~> 0.59", require: false
+end
+
+group :development, :test do
+  gem "pry-byebug", "~> 3.6"
+  gem "sqlite3", ">= 1.3", platforms: %i[ruby mswin mswin64 mingw x64_mingw]
+  gem "thor", "~> 0.20"
+end
+
+group :test do
+  gem "capybara", "~> 3.8"
+  gem "database_cleaner", "~> 1.7"
+  gem "factory_bot_rails", "~> 4.11"
+  gem "poltergeist", "~> 1.18"
+  gem "rails-controller-testing", "~> 1.0"
+  gem "rspec-rails", "~> 3.8"
+  gem "shoulda-callback-matchers", "~> 1.1"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov", "~> 0.16"
+end

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

@@ -0,0 +1,44 @@
+# <%= class_name %>
+
+Introduction goes here.
+
+## Installation
+
+Add to your application's Gemfile
+
+```
+gem "<%= theme_name %>", github: "USERNAME/<%= theme_name %>"
+```
+
+Run the bundle command
+
+```
+$ bundle install
+```
+
+If your server was running, restart it to find the assets properly.
+
+## Testing
+
+First, generate a dummy application. You will be required to generate a dummy application before running tests.
+
+```
+$ bundle exec rake dummy_app
+```
+
+Run tests with any of the following
+
+```
+$ bundle exec rake
+$ bundle exec rake spec
+$ bundle exec rake test
+$ bundle exec rspec spec
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/USERNAME/<%= theme_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`)
+5. Create a new Pull Request

data/lib/archangel/commands/templates/theme/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require "archangel/testing_support/rake/dummy_rake"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+desc "Generates a dummy app for testing"
+task :dummy_app do
+  # ENV["DB"] = "sqlite3" # mysql, postgresql, sqlite3, etc
+  ENV["LIB_NAME"] = "<%= theme_name %>"
+
+  Rake::Task["dummy:generate"].invoke
+end
+
+desc "Run RSpec tests"
+task test: :spec