archangel 0.0.2

data/lib/generators/archangel/dummy/dummy_generator.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+require "active_support/core_ext/hash"
+
+module Archangel
+  ##
+  # Archangel generator
+  #
+  module Generators
+    ##
+    # Archangel dummy application generator for testing
+    #
+    class DummyGenerator < Rails::Generators::Base
+      desc "Creates blank Rails application, installs Archangel"
+
+      class_option :lib_name, default: "", desc: "Library name"
+      class_option :database, default: "sqlite",
+                              desc: "Type of database to use in dummy app."
+
+      source_root File.expand_path("templates", __dir__)
+
+      ##
+      # Database type
+      #
+      attr_reader :database
+
+      ##
+      # Library name
+      #
+      attr_reader :lib_name
+
+      ##
+      # Rails flags available to be passed with generator
+      #
+      PASSTHROUGH_OPTIONS = %i[
+        skip_active_record skip_javascript database javascript quiet pretend
+        force skip
+      ].freeze
+
+      ##
+      # Do not allowing running the generator within the application
+      #
+      def prevent_application_dummy
+        return unless Rails.try(:root) && !Rails.root.blank?
+
+        abort "Dummy generator cannot be run outside Archangel extension."
+      end
+
+      ##
+      # Remove dummy directory
+      #
+      def clean_up
+        remove_directory_if_exists(dummy_path)
+      end
+
+      ##
+      # Generate new dummy directory
+      #
+      def generate_dummy
+        opts = {}.merge(options).slice(*PASSTHROUGH_OPTIONS)
+
+        opts[:database] = "sqlite3" if opts[:database].blank?
+        opts[:force] = true
+        opts[:skip_bundle] = true
+        opts[:skip_git] = true
+        opts[:old_style_hash] = false
+        opts[:skip_turbolinks] = true
+
+        puts "Generating dummy Rails application..."
+
+        invoke Rails::Generators::AppGenerator,
+               [File.expand_path(dummy_path, destination_root)],
+               opts
+      end
+
+      ##
+      # Copy dummy application files
+      #
+      def copy_dummy_config
+        @lib_name = options[:lib_name]
+        @database = options[:database]
+
+        %w[config/database.yml].each do |tpl|
+          template tpl, "#{dummy_path}/#{tpl}", force: true
+        end
+      end
+
+      ##
+      # Insert config options in test environment
+      #
+      def test_default_url
+        insert_into_file("#{dummy_path}/config/environments/test.rb",
+                         after: "Rails.application.configure do") do
+          <<-DEFAULT_URL.strip_heredoc.indent(2)
+
+            config.action_mailer.default_url_options = {
+              host: "localhost",
+              port: 3000
+            }
+
+            config.action_view.raise_on_missing_translations = true
+
+          DEFAULT_URL
+        end
+      end
+
+      ##
+      # Remove unnecessary generated files
+      #
+      def dummy_cleanup
+        inside dummy_path do
+          paths = %w[.gitignore db/seeds.rb Gemfile lib/tasks public/robots.txt
+                     spec test vendor]
+
+          paths.each { |path| remove_file path }
+        end
+      end
+
+      protected
+
+      def remove_directory_if_exists(path)
+        remove_dir(path) if File.directory?(path)
+      end
+
+      def inject_require_for(requirement)
+        insert_into_file("config/application.rb",
+                         before: /require "#{@lib_name}"/,
+                         verbose: true) do
+          <<-APP_CONFIG.strip_heredoc.indent(2)
+
+            begin
+              require "#{requirement}"
+            rescue LoadError
+              # #{requirement} is not available.
+            end
+
+          APP_CONFIG
+        end
+      end
+
+      def dummy_path
+        ENV["DUMMY_PATH"] || "spec/dummy"
+      end
+    end
+  end
+end

data/lib/generators/archangel/dummy/templates/config/database.yml

@@ -0,0 +1,48 @@
+<%- case ENV["DB"] when "mysql" -%>
+default: &default
+  adapter: mysql2
+  encoding: utf8
+
+development:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_development
+
+test:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_test
+
+production:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_production
+<%- when "postgres" -%>
+default: &default
+  adapter: postgresql
+  username: postgres
+
+development:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_development
+
+test:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_test
+
+production:
+  <<: *default
+  database: archangel_<%= options[:lib_name] %>_production
+<%- else -%>
+default: &default
+  adapter: sqlite3
+
+development:
+  <<: *default
+  database: db/archangel_<%= options[:lib_name] %>_development.sqlite3
+
+test:
+  <<: *default
+  database: db/archangel_<%= options[:lib_name] %>_test.sqlite3
+
+production:
+  <<: *default
+  database: db/archangel_<%= options[:lib_name] %>_production.sqlite3
+<%- end -%>

data/lib/generators/archangel/install/install_generator.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/indent"
+require "rails/generators"
+require "highline/import"
+
+module Archangel
+  ##
+  # Archangel generator
+  #
+  module Generators
+    ##
+    # Archangel install generator
+    #
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :admin_email, type: :string, desc: "Admin email address"
+      class_option :admin_name, type: :string, desc: "Admin name"
+      class_option :admin_password, type: :string, desc: "Admin password"
+      class_option :admin_username, type: :string, desc: "Admin username"
+
+      class_option :migrate, type: :boolean,
+                             default: true,
+                             desc: "Run database migrations"
+      class_option :quiet, type: :boolean,
+                           default: false,
+                           desc: "Silence is golden"
+      class_option :route_path, type: :string, default: "", desc: "Root path"
+      class_option :seed, type: :boolean, default: false, desc: "Seed database"
+
+      desc "Install Archangel for the first time"
+
+      ##
+      # Do not allowing running the generator within the gem
+      #
+      def prevent_nested_install
+        return unless Rails.try(:root) && Rails.root.blank?
+
+        abort "Install generator cannot be run inside Archangel extension."
+      end
+
+      ##
+      # Copy files
+      #
+      def add_files
+        say_quietly "Copying files..."
+
+        %w[
+          .env.sample
+          config/initializers/carrierwave.rb
+          config/initializers/devise.rb
+          config/archangel.yml
+        ].each do |file|
+          template file
+        end
+      end
+
+      ##
+      # Copy vendor files for Archangel extensions
+      #
+      def add_vendor_files
+        say_quietly "Copying files..."
+
+        %w[auth backend frontend].each do |section|
+          template "vendor/assets/javascripts/archangel/#{section}.js"
+          template "vendor/assets/stylesheets/archangel/#{section}.css"
+        end
+      end
+
+      ##
+      # Disallow backend indexing in robots.txt
+      #
+      def disallow_robots
+        return unless File.exist? "public/robots.txt"
+
+        append_file "public/robots.txt", <<-ROBOTS.strip_heredoc
+          User-agent: *
+          Disallow: /backend
+        ROBOTS
+      end
+
+      ##
+      # Create seed file if needed
+      #
+      def create_seeds_file
+        return unless options[:seed]
+        return if File.exist?(File.join(destination_root, "db", "seeds.rb"))
+
+        say_quietly "Creating db/seeds.rb file..."
+
+        create_file "db/seeds.rb"
+      end
+
+      ##
+      # Append Archangel seeds to seed file
+      #
+      def add_archangel_seed
+        return unless options[:seed]
+
+        say_quietly "Seeding local seeds.rb..."
+
+        append_file "db/seeds.rb", <<-SEEDS.strip_heredoc
+          # Archangel seed data
+          Archangel::Engine.load_seed
+
+        SEEDS
+      end
+
+      ##
+      # Install Archangel migrations
+      #
+      def install_migrations
+        say_quietly "Installing migrations..."
+
+        silence_warnings { rake "railties:install:migrations" }
+      end
+
+      ##
+      # Create database is needed
+      #
+      def create_database
+        say_quietly "Creating database..."
+
+        silence_warnings { rake "db:create" }
+      end
+
+      ##
+      # Run Archangel migrations
+      #
+      def run_migrations
+        if options[:migrate]
+          say_quietly "Running migrations..."
+
+          silence_warnings { rake "db:migrate" }
+        else
+          say_quietly "Skipping migrations. Run `rake db:migrate` yourself."
+        end
+      end
+
+      ##
+      # Seed database
+      #
+      def seed_database
+        if options[:migrate] && options[:seed]
+          say_quietly "Inseminating..."
+
+          silence_warnings { rake "db:seed #{rake_seed_options}" }
+        else
+          say_quietly "Skipping seed data. Run `rake db:seed` yourself."
+        end
+      end
+
+      ##
+      # Insert Archangel routes
+      #
+      def insert_routes
+        say_quietly "Adding Archangel routes..."
+
+        insert_into_file(File.join("config", "routes.rb"),
+                         after: "Rails.application.routes.draw do\n") do
+          <<-ROUTES.strip_heredoc.indent(2)
+            # This mounts Archangel's routes at the root of your application. If you would
+            # like to change where the engine is mounted, simply change the :at option to
+            # reflect your needs.
+            #
+            mount Archangel::Engine, at: "/#{options[:route_path]}"
+
+          ROUTES
+        end
+
+        say_quietly "Your application's config/routes.rb has been updated."
+      end
+
+      ##
+      # After install message
+      #
+      def banner
+        say_quietly "*" * 80
+        say_quietly "  Done, sir! Done! Archangel has been installed!"
+      end
+
+      protected
+
+      no_tasks do
+        def rake_seed_options
+          fields = %w[admin_email admin_name admin_password admin_username]
+
+          fields.map do |field|
+            field_option = options[field.to_sym]
+
+            "#{field.upcase}=#{field_option}" unless field_option.blank?
+          end.compact.join(" ")
+        end
+
+        def say_quietly(message)
+          puts message unless options[:quiet]
+        end
+      end
+    end
+  end
+end

data/lib/generators/archangel/install/templates/.env.sample

@@ -0,0 +1,4 @@
+AWS_REGION=us-east-1
+AWS_BUCKET=archangel
+AWS_ACCESS_KEY_ID=ABC123
+AWS_SECRET_ACCESS_KEY=123ABC

data/lib/generators/archangel/install/templates/config/archangel.yml

@@ -0,0 +1,54 @@
+# Auth root path.
+# Default is "account"
+#
+auth_path: "account"
+
+# Backend root path.
+# Default is "backend"
+#
+backend_path: "backend"
+
+# File extension whitelist of asset uploads.
+# Default is ['css', 'gif', 'jpeg', 'jpg', 'js', 'png']
+#
+asset_extension_whitelist:
+  - css
+  - gif
+  - jpeg
+  - jpg
+  - js
+  - png
+
+# Maximum file size of for asset uploads.
+# Default is `2.megabytes`
+#
+asset_maximum_file_size: 2.megabytes
+
+# File extension whitelist of favicon uploads.
+# Default is ['gif', 'ico', 'jpeg', 'jpg', 'png']
+#
+favicon_extension_whitelist:
+  - gif
+  - ico
+  - jpeg
+  - jpg
+  - png
+
+# Maximum file size of for favicon uploads.
+# Default is `2.megabytes`
+#
+favicon_maximum_file_size: 2.megabytes
+
+# File extension whitelist of general image uploads.
+# Default is ['gif', 'jpeg', 'jpg', 'png']
+#
+image_extension_whitelist:
+  - gif
+  - jpeg
+  - jpg
+  - png
+
+# Maximum file size of for general image uploads.
+# Default is `2.megabytes`
+#
+image_maximum_file_size: 2.megabytes

data/lib/generators/archangel/install/templates/config/initializers/carrierwave.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+CarrierWave.configure do |config|
+  # Local file storage
+  config.storage = :file
+
+  # Want to use upload files to AWS S3? Take a look at Carrierwave documentation
+  # https://github.com/carrierwaveuploader/carrierwave#fog
+
+  # Use local file storage for tests
+  if Rails.env.test?
+    config.storage = :file
+    config.enable_processing = false
+  end
+end

data/lib/generators/archangel/install/templates/config/initializers/devise.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate random
+  # tokens. Changing this key will render invalid all existing confirmation,
+  # reset password and unlock tokens in the database.
+  # Devise will use the `secret_key_base` on Rails 4+ applications as its
+  # `secret_key` by default. You can change it below and use your own
+  # secret key.
+  config.secret_key = "<%= SecureRandom.hex(50).to_s %>"
+
+  # Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = "noreply@example.com"
+end

data/lib/generators/archangel/install/templates/vendor/assets/javascripts/archangel/auth.js

@@ -0,0 +1,3 @@
+// This is where all of the Archangel extensions will add their Javascript for the auth
+//
+//= require_self

data/lib/generators/archangel/install/templates/vendor/assets/javascripts/archangel/backend.js

@@ -0,0 +1,3 @@
+// This is where all of the Archangel extensions will add their Javascript for the backend
+//
+//= require_self

data/lib/generators/archangel/install/templates/vendor/assets/javascripts/archangel/frontend.js

@@ -0,0 +1,3 @@
+// This is where all of the Archangel extensions will add their Javascript for the frontend
+//
+//= require_self

data/lib/generators/archangel/install/templates/vendor/assets/stylesheets/archangel/auth.css

@@ -0,0 +1,5 @@
+/*
+ * This is where all of the Archangel extensions will add their stylesheets for the auth
+ *
+ *= require_self
+ */

data/lib/generators/archangel/install/templates/vendor/assets/stylesheets/archangel/backend.css

@@ -0,0 +1,5 @@
+/*
+ * This is where all of the Archangel extensions will add their stylesheets for the backend
+ *
+ *= require_self
+ */

data/lib/generators/archangel/install/templates/vendor/assets/stylesheets/archangel/frontend.css

@@ -0,0 +1,5 @@
+/*
+ * This is where all of the Archangel extensions will add their stylesheets for the frontend
+ *
+ *= require_self
+ */

data/lib/tasks/archangel/version_task.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :archangel do
+  desc "Current Archangel version"
+  task :version do
+    puts "Archangel #{Archangel.version}"
+  end
+end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>, html: { class: "form-horizontal", autocomplete: "false" }) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

data/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "archangel",
+  "version": "0.0.1",
+  "private": true,
+  "author": "dfreerksen <dfreerksen@gmail.com>",
+  "homepage": "https://github.com/archangel/archangel/",
+  "description": "Archangel is a Rails CMS.",
+  "keywords": [
+    "archangel",
+    "cms",
+    "rails",
+    "ruby"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "archangel/archangel"
+  },
+  "bugs": {
+    "url": "https://github.com/archangel/archangel/issues"
+  },
+  "files": [
+    "lib/assets/compiled/*.js"
+  ],
+  "main": "index.js",
+  "scripts": {
+    "test": "test"
+  },
+  "devDependencies": {
+    "eslint": "^4.18.2"
+  },
+  "dependencies": {}
+}