archangel 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e58c0764542b5ba954a4a76a78cf5ba377c33e91a5baf3e76428b1c02dce7d4
-  data.tar.gz: b7ebd658a326d420160b61cf183227d147fc2ebcb2714a53ae052afe07ed0b7a
+  metadata.gz: 68e5d684902d60ef8038ad7742db68f526aad40eb98a774efbd99c36e2ebc39d
+  data.tar.gz: a2ea939de0bb71993fac52d5ad02a793a34196b92512f9f5e6124e0c37c38f7c
 SHA512:
-  metadata.gz: c3f4cf33c322c9a508a2eed8b933da2f31c79c087c67f5bfc167980b63bc42d37c5b7c5df54149562810dc0d39854490a6192ad81aba6be89b856d72f50860a3
-  data.tar.gz: e71e3176820ccacea49121788aefb5b3125d01d250a877f86bda917c39d8770411f591620b33b78241d1518c102894821a9d8899d31c8188fecddf5852345dc8
+  metadata.gz: acb8fef35d67234c3594efc0f529d1c6a3058cb3ad752b85d36d0b8b4c543734860ba28b5d58f2221981e6094a4a0e269ce4b0fcd22f0b215e35282b88167a8f
+  data.tar.gz: 8265bb0b3f2141364c1abb2b00408553c744c633e2e1182a9dfa5f6ad2cea7ee297738f47007d640ffe01cc1eef98b42834c096f7b5ce4a46c39fd7a2e68c670

data/.github/ISSUE_TEMPLATE.md

@@ -1,23 +1,15 @@
 # Summary
 
-A few sentences describing the issue.
-
-Expected behavior...
-
-Actual behavior...
-
-Possible fix...
-
-Stacktrace...
+A few sentences describing the issue; including expected behavior, actual behavior, possible fix or stacktrace.
 
 ## Steps to Reproduce
 
-1.
-2.
-3.
+1. Do this...
+2. Do that...
+3. ...
 
 ## Your Environment
 
-* Ruby Version:
-* Gem Version:
-* OS and Version:
+* Ruby Version: 2.5
+* Rails Version: 5
+* Archangel Version: < 1

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -11,8 +11,3 @@ A few sentences describing the changes and overall goal(s) of the pull request.
 
 * Feature or item being removed or modified
 * ...
-
-## Migrations
-
-* [ ] Yes
-* [X] No

data/.gitignore

@@ -2,6 +2,7 @@
 .DS_Store
 .Trashes
 .yardoc/
+archangel_*/
 brakeman.html
 coverage/
 Desktop.ini

data/.hound.yml

@@ -10,8 +10,8 @@ jshint:
   config_file: .jshintrc
   ignore_file: .jshintignore
 
-# # https://github.com/bbatsov/rubocop
-ruby:
+# https://github.com/bbatsov/rubocop
+rubocop:
   enabled: true
   config_file: .rubocop.yml
 

data/.jshintignore

@@ -0,0 +1,5 @@
+coverage/
+doc/
+node_modules/
+spec/
+vendor/

data/.jshintrc

@@ -0,0 +1,28 @@
+{
+  "globals": {
+    "$": true,
+    "Archangel": true,
+    "document": true,
+    "jQuery": true,
+    "localStorage": true,
+    "Sortable": true,
+    "window": true,
+    "XMLHttpRequest": true
+  },
+  "boss": true,
+  "curly": true,
+  "debug": false,
+  "devel": false,
+  "eqeqeq": true,
+  "esversion": 6,
+  "evil": false,
+  "jquery": true,
+  "lastsemic": true,
+  "newcap": false,
+  "node": true,
+  "onecase": true,
+  "quotmark": "single",
+  "strict": true,
+  "undef": true,
+  "unused": true
+}

data/.nvmrc

@@ -0,0 +1 @@
+8.11.1

data/CONTRIBUTING.md

@@ -9,16 +9,13 @@ The following is a set of guidelines for contributing to Archangel and its manag
 * [Code of Conduct](#code-of-conduct)
 * [How To Contribute](#how-to-contribute)
 * [Issues](#issues)
-* [Pull Requests](#pull-requests)
-* [Testing](#code)
-* [Code Analysis](#code)
 * [Security and Maintenance](#security-and-maintenance)
-* [Documentation](#code)
+* [Developers](#developers)
+* [Pull Requests](#pull-requests)
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
-uphold this code. Please report unacceptable behavior to [archangel.cms@gmail.com](mailto:archangel.cms@gmail.com).
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [archangel.cms@gmail.com](mailto:archangel.cms@gmail.com).
 
 ## How To Contribute
 
@@ -33,118 +30,20 @@ Help is always appreciated. If you are not able to contribute with code, bug rep
 
 Archangel uses [Github Issues](https://github.com/archangel/archangel/issues) to manage issues. A [number of labels](https://github.com/archangel/archangel/labels) are used to control flow and function. Enhancements and feature requests can also be submitted. Extension ideas are also accepted.
 
-## Pull Requests
-
-We gladly accept pull requests to Archangel.
-
-1. Fork the repo ([https://github.com/archangel/archangel/fork](https://github.com/archangel/archangel/fork))
-2. Clone the fork to your local machine
-3. Run `bundle install` inside `archangel` directory
-4. Make your updates or improvements
-5. Commit your changes (`git commit -am 'Did some good things'`)
-6. Push to your fork (`git push`)
-7. Create a new Pull Request
-
-## Testing
-
-Tests are always necessary. If you find yourself thinking, "Do I need to write tests for this?," the answer is yes. [Travis CI](https://travis-ci.org/) is used for running tests. To get the best possible overview of issues with different Ruby versions, Archangel is tested with multiple various of Ruby. See [`.travis.yml`](.travis.yml) for the versions of Ruby tested.
-
-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
-```
-
-You can also enable fail fast in order to stop tests at the first failure
-
-```
-$ bundle exec rspec spec --fail-fast
-```
-
-## Code Analysis
-
-Various tools are used to make sure code is linted and formatted correctly.
-
-### Reek
-
-[Reek](https://github.com/troessner/reek) is a code smell detector for Ruby.
-
-```
-$ reek
-```
-
-### RuboCop
-
-[RuboCop](https://github.com/bbatsov/rubocop) is a Ruby static code analyzer.
-
-```
-$ rubocop
-```
-
-### scss-lint
-
-[scss-lint](https://github.com/brigade/scss-lint) is a SCSS style analyzer.
-
-```
-$ scss-lint .
-```
-
 ## 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/).
 
-```
-$ brakeman
-```
-
-or
-
-```
-$ bundle exec brakeman
-```
-
-## Documentation
+## Developers
 
-[Yard](https://github.com/lsegal/yard) is used to generate documentation. [Online documentation is available](http://www.rubydoc.info/github/archangel/archangel/master)
+Developer documentation [is available](https://github.com/archangel/archangel/blob/master/docs/Developers.md).
 
-Build the documentation
-
-```
-$ yard
-```
-
-or
-
-```
-$ yard doc
-```
-
-Build the documentation and list all undocumented objects
-
-```
-$ yard stats --list-undoc
-```
-
-Inch documentation statistics can be generated
+## Pull Requests
 
-```
-$ inch
-```
+1. Fork the repo ([https://github.com/archangel/archangel/fork](https://github.com/archangel/archangel/fork))
+2. Clone the fork to your local machine
+3. Run `bundle install` inside `archangel` directory
+4. Make your updates or improvements
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to your fork (`git push origin my-new-feature`)
+7. Create a new Pull Request

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 group :development do
   gem "brakeman", "~> 4.1", require: false
   gem "bundler-audit", "~> 0.6", require: false
-  gem "inch", "~> 0.8.0.rc2", require: false
+  gem "inch", "~> 0.8", require: false
   gem "listen", "~> 3.1", require: false
   gem "mdl", "~> 0.4", require: false
   gem "reek", "~> 4.7", require: false
@@ -23,11 +23,11 @@ group :development, :test do
 end
 
 group :test do
-  gem "capybara", "~> 2.17"
+  gem "capybara", "~> 3.0"
   gem "coveralls", "~> 0.8"
   gem "database_cleaner", "~> 1.6"
   gem "factory_bot_rails", "~> 4.8"
-  gem "poltergeist", "~> 1.17"
+  gem "poltergeist", "~> 1.18"
   gem "rails-controller-testing", "~> 1.0"
   gem "rspec-rails", "~> 3.7"
   gem "shoulda-callback-matchers", "~> 1.1"

data/README.md

@@ -12,8 +12,6 @@
 
 Archangel is a Rails CMS.
 
-The Archangel logo is made by [Joshua Boyd](http://www.joshadamboyd.com/)
-
 This project rocks and uses MIT-LICENSE.
 
 [Online documentation is available](http://www.rubydoc.info/github/archangel/archangel/master)
@@ -27,7 +25,7 @@ Deploy a sample application to [Heroku](https://www.heroku.com/) to play with.
 ## Requirements
 
 * Ruby >= 2.2.10
-* Rails ~> 5.1.4
+* Rails ~> 5.1
 
 ## Installation
 
@@ -71,38 +69,6 @@ Run migrations
 $ bundle exec rails db:migrate
 ```
 
-## Testing
-
-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
-```
-
-You can also enable fail fast in order to stop tests at the first failure
-
-```
-$ bundle exec rspec spec --fail-fast
-```
-
 ## Code Analysis
 
 * [Travis CI](https://travis-ci.org/) is used for running tests.
@@ -113,11 +79,20 @@ $ bundle exec rspec spec --fail-fast
 
 General documentation for developers
 
+* [Contributing Guide](https://github.com/archangel/archangel/blob/master/CONTRIBUTING.md)
 * [Documentation for Archangel gem developers](https://github.com/archangel/archangel/blob/master/docs/Developers.md)
-* [Documentation for extension developers](https://github.com/archangel/archangel/blob/master/docs/ExtensionDevelopers.md)
-* [Documentation for theme developers](https://github.com/archangel/archangel/blob/master/docs/ThemeDevelopers.md)
+* [Documentation for extension developers](https://github.com/archangel/archangel/blob/master/docs/Extension/Developers.md)
+* [Documentation for theme developers](https://github.com/archangel/archangel/blob/master/docs/Theme/Developers.md)
 * [Documentation for releasing a gem version](https://github.com/archangel/archangel/blob/master/docs/Release.md) (maintainers only)
 
+## Logo
+
+Archangel's logo was created by [Joshua Boyd](http://www.joshadamboyd.com/).
+
+## Special Thanks
+
+[@archangel-dlt](https://github.com/archangel-dlt/) originally had the "archangel" gem name and were kind enough to give it up
+
 ## Contributing
 
 A [contributing guide](https://github.com/archangel/archangel/blob/master/CONTRIBUTING.md) is available.

data/Rakefile

@@ -25,3 +25,14 @@ task :dummy_app do
 
   Rake::Task["dummy:generate"].invoke
 end
+
+desc "Remove any generated files and directories"
+task :clean do
+  %w[
+    brakeman.html Gemfile.lock spec/examples.txt yarn.lock
+  ].each { |file| rm_f file }
+
+  %w[
+    .yardoc coverage doc pkg archangel_* node_modules pkg spec/dummy
+  ].each { |directory| rm_rf directory }
+end

data/app/controllers/archangel/application_controller.rb

@@ -24,8 +24,7 @@ module Archangel
 
     theme :theme_resolver
 
-    rescue_from ActionController::UnknownController,
-                AbstractController::ActionNotFound,
+    rescue_from AbstractController::ActionNotFound,
                 ActionView::MissingTemplate,
                 ActiveRecord::RecordNotFound, with: :render_404_error
 

data/archangel.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
   s.summary     = "Archangel CMS"
   s.description = "Archangel is a Rails CMS"
   s.license     = "MIT"
-  s.files       = `git ls-files`.split($ORS)
+  s.files       = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
 
   s.required_ruby_version = ">= 2.2.10"
 
@@ -48,5 +49,6 @@ Gem::Specification.new do |s|
   s.add_dependency "responders", "~> 2.4"
   s.add_dependency "selectize-rails", "~> 0.12"
   s.add_dependency "simple_form", "~> 4.0"
+  s.add_dependency "thor", "~> 0.19"
   s.add_dependency "validates", "~> 1.0"
 end

data/bin/archangel

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "thor/group"
+
+case ARGV.first.downcase
+when "extension"
+  require "archangel/command/extension"
+
+  ARGV.shift
+
+  Archangel::Command::Extension.start
+else
+  puts "Unknown Archangel command."
+end

data/docs/Developers.md

@@ -1,3 +1,124 @@
 # Archangel Development
 
-TODO
+This is documentation for developing the Archangel gem
+
+Documentation for theme developers [is available](https://github.com/archangel/archangel/blob/master/docs/Theme/Developers.md).
+
+Documentation for theme developers [is available](https://github.com/archangel/archangel/blob/master/docs/Extension/Developers.md).
+
+## Testing
+
+[Travis CI](https://travis-ci.org/) is used for running tests. To get the best possible overview of issues with different Ruby versions, Archangel is tested with multiple various of Ruby. See [.travis.yml](https://github.com/archangel/archangel/blob/master/.travis.yml) for the versions of Ruby tested.
+
+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
+```
+
+You can also enable fail fast in order to stop tests at the first failure
+
+```
+$ bundle exec rspec spec --fail-fast
+```
+
+## Code Analysis
+
+Various tools are used to ensure code is linted and formatted correctly.
+
+### JSHint
+
+[jshint](https://github.com/jshint/jshint) is a Javascript style analyzer.
+
+```
+$ jshint app/assets
+```
+
+> NOTE: Integrations for multiple text editors and IDEs are [also available](http://jshint.com/install/).
+
+### Reek
+
+[Reek](https://github.com/troessner/reek) is a code smell detector for Ruby.
+
+```
+$ reek
+```
+
+> NOTE: Integrations for multiple text editors and IDEs are [also available](https://github.com/troessner/reek#editor-integrations).
+
+### RuboCop
+
+[RuboCop](https://github.com/bbatsov/rubocop) is a Ruby static code analyzer.
+
+```
+$ rubocop
+```
+
+### scss-lint
+
+[scss-lint](https://github.com/brigade/scss-lint) is a SCSS style analyzer.
+
+```
+$ scss-lint .
+```
+
+## 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/).
+
+```
+$ bundle exec brakeman
+$ open brakeman.html
+```
+
+### Cleanup
+
+Remove all generated files
+
+```
+$ bundle exec rake clean
+```
+
+## Documentation
+
+[Yard](https://github.com/lsegal/yard) is used to generate documentation. [Online documentation is available](http://www.rubydoc.info/github/archangel/archangel/master)
+
+Build the documentation
+
+```
+$ yard doc
+```
+
+Build the documentation and list all undocumented objects
+
+```
+$ yard stats --list-undoc
+```
+
+[Inch](https://inch-ci.org/) documentation statistics can be generated
+
+```
+$ inch
+```
+
+## Releasing
+
+Documentation for maintainers to release a new gem version [is available](https://github.com/archangel/archangel/blob/master/docs/Release.md).

data/docs/Extension/Controllers.md

@@ -0,0 +1,139 @@
+# Controllers
+
+Controllers are separated by `frontend`, `backend` or `auth` namespaces. Each section should be separated for functional clarity.
+
+## Backend Controllers
+
+For Backend controllers, create your controller at `app/controllers/archangel/backend/foos_controller.rb` add the following.
+
+```
+module Archangel
+  module Backend
+    class FoosController < BackendController
+      before_action :set_resources, only: %i[index]
+      before_action :set_resource, only: %i[destroy edit show update]
+      before_action :set_new_resource, only: %i[create new]
+
+      def index
+        respond_with @foos
+      end
+
+      def show
+        respond_with @foo
+      end
+
+      def new
+        respond_with @foo
+      end
+
+      def create
+        @foo.save
+
+        respond_with @foo, location: -> { location_after_create }
+      end
+
+      def edit
+        respond_with @foo
+      end
+
+      def update
+        @foo.update(resource_params)
+
+        respond_with @foo, location: -> { location_after_update }
+      end
+
+      def destroy
+        @foo.destroy
+
+        respond_with @foo, location: -> { location_after_destroy }
+      end
+
+      protected
+
+      def permitted_attributes
+        %w[bar bat baz slug]
+      end
+
+      def set_resources
+        @foos = current_site.foos.page(page_num).per(per_page)
+
+        authorize @foos
+      end
+
+      def set_resource
+        resource_id = params.fetch(:id)
+
+        # When `to_param` is not used in the model
+        @foo = current_site.foos.find_by!(id: resource_id)
+
+        # When `to_param` is used in the model
+        # @foo = current_site.foos.find_by!(slug: resource_id)
+
+        authorize @foo
+      end
+
+      def set_new_resource
+        new_params = action_name.to_sym == :create ? resource_params : nil
+
+        @foo = current_site.foos.new(new_params)
+
+        authorize @foo
+      end
+
+      def resource_params
+        params.require(resource_namespace).permit(permitted_attributes)
+      end
+
+      def resource_namespace
+        controller_name.singularize.to_sym
+      end
+
+      def location_after_create
+        location_after_save
+      end
+
+      def location_after_update
+        location_after_save
+      end
+
+      def location_after_destroy
+        location_after_save
+      end
+
+      def location_after_save
+        backend_foos_path
+      end
+    end
+  end
+end
+```
+
+Extending `BackendController` assumes your controller requires policy authorization. If your controller does not require authorization, use the following
+
+```
+module Archangel
+  module Backend
+    class FoosController < BackendController
+      include Archangel::SkipAuthorizableConcern
+
+      ...
+    end
+  end
+end
+```
+
+To change the `id` for constructing a URL to this object, override `set_resource` in your controller.
+
+```
+def set_resource
+  resource_id = params.fetch(:id)
+
+  @foo = current_site.foos.find_by!(slug: resource_id)
+
+  authorize @foo
+end
+```
+
+## Testing Backend Controllers
+
+TODO