archangel 0.0.2 → 0.0.3

data/docs/Extension/Developers.md

@@ -0,0 +1,27 @@
+# Extension Developers
+
+Extensions are meant to extend the functionality of Archangel. Documentation for theme development is [also available](https://github.com/archangel/archangel/blob/master/docs/Theme/Developers.md).
+
+Feeling bored? Looking for ideas? Take a look at possible [ideas for extensions](https://github.com/archangel/archangel/blob/master/docs/Extension/Ideas.md).
+
+## Generate an extension
+
+Generate an Archangel extension with `archangel extension NAME`
+
+To generate an extension at `PWD` with the name `archangel_foo`
+
+```
+$ archangel extension foo
+```
+
+## Best Practices
+
+The following are best practice guides for building and managing Archangel extensions.
+
+* [Controllers](https://github.com/archangel/archangel/blob/master/docs/Extension/Controllers.md)
+* [Helpers](https://github.com/archangel/archangel/blob/master/docs/Extension/Helpers.md)
+* [Models](https://github.com/archangel/archangel/blob/master/docs/Extension/Models.md)
+* [Policies](https://github.com/archangel/archangel/blob/master/docs/Extension/Policies.md)
+* [Routes](https://github.com/archangel/archangel/blob/master/docs/Extension/Routes.md)
+* [Views](https://github.com/archangel/archangel/blob/master/docs/Extension/Views.md)
+* [Uploaders](https://github.com/archangel/archangel/blob/master/docs/Extension/Uploaders.md)

data/docs/Extension/Helpers.md

@@ -0,0 +1,17 @@
+# Helpers
+
+Helpers are separated by `frontend`, `backend` or `auth` namespaces. Each section should be separated for functional clarity.
+
+## Backend Helpers
+
+For Backend helpers, create your helper at `app/helpers/archangel/backend/foos_helper.rb` add the following
+
+```
+module Archangel
+  module Backend
+    module FoosHelper
+      ...
+    end
+  end
+end
+```

data/docs/Extension/Ideas.md

@@ -0,0 +1,131 @@
+# Extension Ideas
+
+Feeling bored? Looking for ideas?
+
+_ \* In no particular order_
+
+* Preview
+  * Page preview
+* Angular
+  * Helper extension to include for themes built with Angular
+* React
+  * Helper extension to include for themes built with React
+* Vue
+  * Helper extension to include for themes built with Vue
+* Aurelia
+  * Helper extension to include for themes built with Aurelia
+* Search
+  * Elasticsearch
+  * Ransack
+* Comments
+  * Facebook
+  * Disqus
+  * Database
+    * Auto approve
+    * Manual approve
+* Migrate
+  * Export for Wordpress
+  * Export for Refinary
+  * Import from Wordpress
+  * Import from Refinary
+* Forms
+  * WYSIWYG for custom form builder
+  * Honeypot
+  * Time
+  * Captcha
+* Multi-tenant
+  * Types
+    * Domain
+    * Subdomain
+    * Schema switching
+  * Manage domains
+  * CLI to create schemas
+  * Background worker to create schemas
+* Notifications
+* json_ld
+* API
+  * CORS
+  * Rate limits
+* GraphQL
+* Social Like
+  * Types
+    * Facebook
+    * Database
+  * Toggle enabled/disabled by default
+  * Toggle enabled/disabled per page
+* Social Share
+  * Toggle enabled/disabled by default
+  * Toggle enabled/disabled per page
+* robots.txt
+* RSS feed
+* Sitemap
+  * Columns
+    * changefreq
+      * always
+      * hourly
+      * daily
+      * weekly
+      * monthly
+      * yearly
+      * never
+    * priority
+      * 0.0..1.0
+  * sitemap.xml
+  * sitemap.xml.gz
+  * Update robots.txt
+  * Rebuild on Page save (background worker)
+  * Notify search engines (background worker)
+* 2FA
+  * Opt-in
+  * Force all
+* Oauth
+* Splash Page
+  * Types
+    * Overlay
+    * Redirect
+  * Start At
+  * End At
+  * Remember with Javascript cookie
+  * Cookie lifetime
+* Pixel trackers
+  * Location
+    * Head
+    * Body (top)
+    * Body (bottom)
+* Statistics/Analytics
+  * Google Analytics
+  * Graphs/Charts
+* History/Versions
+  * Roll back to previous versions
+* Activity
+  * Log activity in backend
+* Icons
+  * favicon
+  * Apple
+  * Android
+  * Windows
+* Stylesheet
+  * Site Stylesheet
+  * Per page Stylesheet
+* Javascript
+  * Site Javascript
+  * Per page Javascript
+* Community
+  * Allow registering
+  * User listing
+  * User profile
+  * User search/filter
+  * Friends/Followers
+* Events
+  * Calendar
+  * Reoccurring events
+  * Reminders
+    * sms
+    * email
+  * Google Calendar integration
+  * iCloud Calendar integration
+* Static
+  * Generate static frontend site
+* Help
+  * Help and instructions for each section in Backend
+  * Monetize YouTube videos

data/docs/Extension/Models.md

@@ -0,0 +1,32 @@
+# Models
+
+Models are not separated by `frontend`, `backend` or `auth` and therefore do not need to be namespaced.
+
+Create your model at `app/models/archangel/foo.rb` add the following.
+
+```
+module Archangel
+  class Foo < ApplicationRecord
+    before_validation :parameterize_slug
+
+    validates :bar, presence: true
+    validates :slug, presence: true, uniqueness: true
+
+    belongs_to :site
+
+    protected
+
+    def parameterize_slug
+      self.slug = slug.to_s.downcase.parameterize
+    end
+  end
+end
+```
+
+To change the `id` for constructing a URL to this object you can override `#to_param` in your model to make `foo_path` construct a path using the record `slug` instead of the `id`. See [`#to_param`](https://apidock.com/rails/ActiveRecord/Base/to_param) for further explanation.
+
+```
+def to_param
+  slug
+end
+```

data/docs/Extension/Policies.md

@@ -0,0 +1,42 @@
+# Policies
+
+Policies are not separated by `frontend`, `backend` or `auth` and therefore do not need to be namespaced. [Pundit](https://github.com/varvet/pundit) is used for authorization.
+
+Create your policy at `app/policies/archangel/foo.rb` add the following.
+
+```
+module Archangel
+  class FooPolicy < ApplicationPolicy
+  end
+end
+```
+
+Extending `ApplicationPolicy` will set default authorization throughout the controller. The only reason you would need anything more than this is if you require more complex authorization policies.
+
+Custom routes that are not RESTful need to added.
+
+```
+module Archangel
+  class FooPolicy < ApplicationPolicy
+    def custom?
+      scope.where(id: record.id).exists?
+    end
+  end
+end
+```
+
+To specifically check if the User is an `admin`, `ApplicationPolicy` has a method to do this.
+
+```
+module Archangel
+  class FooPolicy < ApplicationPolicy
+    def destroy?
+      admin_user?
+    end
+
+    def custom?
+      admin_user?
+    end
+  end
+end
+```

data/docs/Extension/Routes.md

@@ -0,0 +1,26 @@
+# Routes
+
+Routes are separated by `frontend`, `backend` or `auth` namespaces. Each section should be separated for functional clarity.
+
+## Backend Routes
+
+For Backend routes, open `config/routes.rb` and add the following
+
+```
+Archangel::Engine.routes.draw do
+  namespace :backend, path: Archangel.config.backend_path do
+    # GET    /backend/foos
+    # POST   /backend/foos
+    # GET    /backend/foos/new
+    # GET    /backend/foos/[ID]/edit
+    # GET    /backend/foos/[ID]
+    # PATCH  /backend/foos/[ID]
+    # PUT    /backend/foos/[ID]
+    # DELETE /backend/foos/[ID]
+    resources :foos do
+      # GET /backend/foos/custom
+      get :custom
+    end
+  end
+end
+```

data/docs/Extension/Uploaders.md

@@ -0,0 +1,3 @@
+# Uploaders
+
+TODO

data/docs/Extension/Views.md

@@ -0,0 +1,3 @@
+# Views
+
+TODO

data/docs/Release.md

@@ -1,6 +1,12 @@
 # Releasing Gem
 
-1. Bump the gem version in `lib/archangel/version.rb`
+1. Clean up generated files
+
+   ```
+   $ bundle exec rake clean
+   ```
+
+2. Bump the gem version in `lib/archangel/version.rb`
 
     Follow the rules of [Semantic Versioning](https://semver.org/). For example:
 
@@ -16,10 +22,10 @@
 
    This will create a new .gem file in `pkg/`. Fix any errors or warnings that come up.
 
-3. Create the gem, tag it in Github and release to Rubygems
+4. Create the gem, tag it in Github and release to Rubygems
 
     ```
     $ bundle exec rake release
     ```
 
-4. Profit!
+5. Profit!

data/docs/Theme/Developers.md

@@ -0,0 +1,7 @@
+# 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).
+
+## Generate a theme
+
+TODO

data/lib/archangel/command/extension.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Archangel
+  ##
+  # Command line
+  #
+  module Command
+    ##
+    # Generate Archangel extension
+    #
+    class Extension < Thor::Group
+      include Thor::Actions
+
+      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
+        prefix_name
+
+        empty_directory extension_name
+
+        copy_directories
+        copy_files
+      end
+
+      ##
+      # Banner
+      #
+      # Say something nice
+      #
+      def banner
+        puts %(
+
+  ******************************************************************
+
+    Your extension has been generated with a gemspec dependency on
+    Archangel v#{archangel_version}
+
+      You look lovely today by the way.
+
+  ******************************************************************
+
+        )
+      end
+
+      no_tasks do
+        def class_name
+          Thor::Util.camel_case extension_name
+        end
+
+        def archangel_version
+          Archangel.version[/(.*)\./, 1]
+        end
+      end
+
+      no_tasks do
+        def prefix_name
+          ext_name = extension_name.downcase
+          ext_name = "archangel_#{ext_name}" unless ext_name =~ /^archangel_/
+
+          @extension_name = Thor::Util.snake_case(ext_name)
+        end
+
+        def copy_directories
+          %w[
+            app bin config lib spec
+          ].each { |dir| directory(dir, "#{extension_name}/#{dir}") }
+
+          chmod("#{extension_name}/bin/rails", 0o755)
+        end
+
+        def copy_files
+          %w[
+            .editorconfig .gitignore .rspec .rubocop.yml Gemfile MIT-LICENSE
+            Rakefile README.md
+          ].each { |tpl| template(tpl, "#{extension_name}/#{tpl}") }
+
+          template("extension.gemspec",
+                   "#{extension_name}/#{extension_name}.gemspec")
+        end
+      end
+    end
+  end
+end

data/lib/archangel/command/templates/extension/.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.rb]
+max_line_length = 80
+
+[*.{css,erb,html,js,scss,ts}]
+max_line_length = 120
+
+[*.{md,json,yml}]
+insert_final_newline = false

data/lib/archangel/command/templates/extension/.gitignore

@@ -0,0 +1,11 @@
+coverage/
+pkg/
+spec/dummy/
+.DS_Store
+.Trashes
+Desktop.ini
+Gemfile.lock
+log/*.log
+rspec.log
+spec/examples.txt
+Thumbs.db

data/lib/archangel/command/templates/extension/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/archangel/command/templates/extension/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'bin/**/*'
+    - 'db/migrate/**/*'
+    - 'spec/dummy/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/lib/archangel/command/templates/extension/Gemfile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rubocop", "~> 0.52", require: false
+end
+
+group :development, :test do
+  gem "pry-byebug", "~> 3.5"
+  gem "sqlite3", ">= 1.3", platforms: %i[ruby mswin mswin64 mingw x64_mingw]
+  gem "thor", "~> 0.19"
+end
+
+group :test do
+  gem "capybara", "~> 2.17"
+  gem "coveralls", "~> 0.8"
+  gem "database_cleaner", "~> 1.6"
+  gem "factory_bot_rails", "~> 4.8"
+  gem "launchy", "~> 2.4"
+  gem "poltergeist", "~> 1.17"
+  gem "rails-controller-testing", "~> 1.0"
+  gem "rspec-rails", "~> 3.7"
+  gem "shoulda-callback-matchers", "~> 1.1"
+  gem "shoulda-matchers", "~> 3.1"
+  gem "simplecov", "~> 0.14"
+end

data/lib/archangel/command/templates/extension/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) <%= Time.now.year %> YOUR NAME
+
+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/lib/archangel/command/templates/extension/README.md

@@ -0,0 +1,79 @@
+# <%= class_name %>
+
+Introduction goes here.
+
+## Installation
+
+Add to your application's Gemfile
+
+```
+gem "<%= extension_name %>", github: "USERNAME/<%= extension_name %>"
+```
+
+Run the bundle command
+
+```
+$ bundle install
+```
+
+Run the install generator
+
+```
+$ bundle exec rails g <%= extension_name %>:install
+```
+
+If your server was running, restart it to find the assets properly.
+
+## Updating
+
+Subsequent updates can be done by bumping the version in your Gemfile then adding the new migrations
+
+```
+$ bundle exec rails <%= extension_name %>:install:migrations
+```
+
+Run migrations
+
+```
+$ bundle exec rails db:migrate
+```
+
+## 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
+
+```
+$ bundle exec rake
+```
+
+or
+
+```
+$ bundle exec rake spec
+```
+
+or
+
+```
+$ bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:
+
+```
+require "<%= extension_name %>/factories"
+```
+
+## Contributing
+
+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`)
+5. Create a new Pull Request

data/lib/archangel/command/templates/extension/Rakefile

@@ -0,0 +1,25 @@
+# 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["LIB_NAME"] = "<%= extension_name %>"
+
+  Rake::Task["dummy:generate"].invoke
+end

data/lib/archangel/command/templates/extension/app/assets/javascripts/archangel/auth/%extension_name%.js.tt

@@ -0,0 +1,3 @@
+// <%= class_name %> auth scripts for Archangel
+//
+//= require_self

data/lib/archangel/command/templates/extension/app/assets/javascripts/archangel/backend/%extension_name%.js.tt

@@ -0,0 +1,3 @@
+// <%= class_name %> backend scripts for Archangel
+//
+//= require_self

data/lib/archangel/command/templates/extension/app/assets/javascripts/archangel/frontend/%extension_name%.js.tt

@@ -0,0 +1,3 @@
+// <%= class_name %> frontend scripts for Archangel
+//
+//= require_self

data/lib/archangel/command/templates/extension/app/assets/stylesheets/archangel/auth/%extension_name%.css.tt

@@ -0,0 +1,5 @@
+/*
+ * <%= class_name %> auth styles for Archangel
+ *
+ *= require_self
+ */

data/lib/archangel/command/templates/extension/app/assets/stylesheets/archangel/backend/%extension_name%.css.tt

@@ -0,0 +1,5 @@
+/*
+ * <%= class_name %> backend styles for Archangel
+ *
+ *= require_self
+ */

data/lib/archangel/command/templates/extension/app/assets/stylesheets/archangel/frontend/%extension_name%.css.tt

@@ -0,0 +1,5 @@
+/*
+ * <%= class_name %> frontend styles for Archangel
+ *
+ *= require_self
+ */