potassium 1.3.5 → 2.0.0

data/lib/potassium/cli/commands/install.rb

@@ -1,22 +1,28 @@
 require 'levenshtein'
 require 'inquirer'
-require "potassium/templates/application/recipe_generator"
+require 'potassium/generators/recipe'
+require 'potassium/recipe'
 
 module Potassium::CLI
   desc "Installs a new feature or library"
   command :install do |c|
-    c.action do |_global_options, _options, args|
+    c.switch "force",
+      desc: "Whether to force the recipe installation",
+      default_value: false
+    c.action do |_global_options, options, args|
       if args.first.nil?
         index = Ask.list('Select a recipe to install', recipe_name_list)
         ARGV << recipe_name_list[index]
-        Potassium::RecipeGenerator.start
+        template = Potassium::RecipeGenerator
+        template.cli_options = options
+        template.start
+      elsif recipe_exists?(args)
+        template = Potassium::RecipeGenerator
+        template.cli_options = options
+        template.start
       else
-        if recipe_exists?(args)
-          Potassium::RecipeGenerator.start
-        else
-          guess = guess_recipe_name(args)
-          puts "Oops! Sorry, that recipe doesn't exist. Were you looking for this?: #{guess}"
-        end
+        guess = guess_recipe_name(args)
+        puts "Oops! Sorry, that recipe doesn't exist. Were you looking for this?: #{guess}"
       end
     end
   end
@@ -34,11 +40,19 @@ module Potassium::CLI
   end
 
   def self.recipe_name_list
-    @recipe_name_list ||= begin
-      source_root = File.expand_path('../../../templates/application/recipes', __FILE__)
-      files = Dir.entries(source_root).select { |e| e.end_with?('.rb') }
-      files.map { |e| e.gsub('.rb', '') }
+    list = []
+
+    source_root = File.expand_path('../../../recipes', __FILE__)
+    Dir.entries(source_root).each do |file_name|
+      if file_name.end_with?('.rb')
+        recipe_name = file_name.gsub('.rb', '')
+        require "potassium/recipes/#{recipe_name}"
+        recipe_class = Recipes.const_get(recipe_name.camelize)
+        list << recipe_name if recipe_class.method_defined?(:install)
+      end
     end
+
+    list
   end
 
   def self.find_closest_recipe(recipe_list, possible_recipe)

data/lib/potassium/{templates/application/generator.rb → generators/application.rb}

@@ -1,13 +1,18 @@
 require "rails/generators"
 require "rails/generators/rails/app/app_generator"
 require "inquirer"
+require "potassium/recipe"
 
 module Potassium
   class ApplicationGenerator < Rails::Generators::AppGenerator
+    class << self
+      attr_accessor :cli_options
+    end
+
     def finish_template
-      require_relative "./helpers/template-dsl"
+      require_relative "../helpers/template-dsl"
       TemplateDSL.extend_dsl(self, source_path: __FILE__)
-      template_location = File.expand_path('./template.rb', File.dirname(__FILE__))
+      template_location = File.expand_path('../templates/application.rb', File.dirname(__FILE__))
       instance_eval File.read(template_location), template_location
       super
     end

data/lib/potassium/{templates/application/recipe_generator.rb → generators/recipe.rb}

@@ -1,13 +1,22 @@
 require "rails/generators"
 require "rails/generators/rails/app/app_generator"
 require "inquirer"
+require "potassium/recipe"
+
+class Rails::AppBuilder
+  include Rails::ActionMethods
+end
 
 module Potassium
   class RecipeGenerator < Rails::Generators::NamedBase
+    class << self
+      attr_accessor :cli_options
+    end
+
     def run_generator
-      require_relative "./helpers/template-dsl"
+      require_relative "../helpers/template-dsl"
       TemplateDSL.extend_dsl(self, source_path: __FILE__)
-      template_location = File.expand_path('./recipe_template.rb', File.dirname(__FILE__))
+      template_location = File.expand_path('../templates/recipe.rb', File.dirname(__FILE__))
       instance_eval File.read(template_location), template_location
     end
   end

data/lib/potassium/helpers/answer-helpers.rb

@@ -0,0 +1,21 @@
+module AnswerHelpers
+  def answer(key, &fallback)
+    found = get(:answers)[key]
+    found.nil? ? fallback.call : found
+  end
+
+  def load_answers
+    set(:answers, extract_answers(self.class.cli_options))
+  end
+
+  private
+
+  def extract_answers(options)
+    options.except(
+      "version-check", :"version-check",
+      "force", :force
+    ).reduce({}) do |hash, (k, v)|
+      hash.merge(k => v == "none" ? nil : v)
+    end
+  end
+end

data/lib/potassium/helpers/docker-helpers.rb

@@ -0,0 +1,37 @@
+class DockerHelpers
+  def initialize(compose_path)
+    @compose_path = compose_path
+    @compose = YAML.load(File.read(compose_path))
+  end
+
+  def add_link(target_service, linked_service)
+    service = @compose[target_service]
+    unless service['links'].is_a? Array
+      service['links'] = []
+    end
+    service['links'].push(linked_service)
+    save
+  end
+
+  def add_env(target_service, variable_key, variable_value)
+    service = @compose[target_service]
+    unless service['environment'].is_a? Hash
+      service['environment'] = {}
+    end
+    service['environment'][variable_key] = variable_value
+    save
+  end
+
+  def add_service(name, definition)
+    service = {}
+    service[name] = YAML.load(definition)
+    @compose.merge!(service)
+    save
+  end
+
+  private
+
+  def save
+    File.open(@compose_path, 'w') { |f| f.write @compose.to_yaml }
+  end
+end

data/lib/potassium/{templates/application/helpers → helpers}/gem-helpers.rb

@@ -32,8 +32,7 @@ module GemHelpers
   end
 
   def build_gemfile
-    call_gem_for_gathered_gems
-    fix_withespace_issues
+    fix_withespace_issues if call_gem_for_gathered_gems
   end
 
   private
@@ -42,6 +41,8 @@ module GemHelpers
     ensure_variable(:gems, {})
     gems = get(:gems)
 
+    return false if gems.empty?
+
     base_gems = gems.delete([:base]) || []
 
     call_gem_for_gems(base_gems)
@@ -51,6 +52,8 @@ module GemHelpers
         call_gem_for_gems(env_gems)
       end
     end
+
+    true
   end
 
   def call_gem_for_gems(gems)
@@ -75,5 +78,6 @@ module GemHelpers
 
   def fix_withespace_issues
     gsub_file("Gemfile", /^group/, "\ngroup")
+    gsub_file("Gemfile", /^\n\n/, "\n")
   end
 end

data/lib/potassium/helpers/info-helpers.rb

@@ -0,0 +1,16 @@
+module InfoHelpers
+  def success(message)
+    say(message, :green)
+    true
+  end
+
+  def error(message)
+    say(message, :red)
+    false
+  end
+
+  def info(message)
+    say(message, :yellow)
+    true
+  end
+end

data/lib/potassium/helpers/readme-helpers.rb

@@ -0,0 +1,85 @@
+module ReadmeHelpers
+  def add_readme_section(header, section, iterpolation_values = {})
+    section_data = readme_section_data(header, section, iterpolation_values)
+    add_readme_header(header, iterpolation_values)
+
+    insert_into_readme(section_data[:header_title]) do
+      <<-HERE.gsub(/^ {6}/, '')
+
+      ### #{section_data[:title]}
+
+      #{section_data[:body]}
+      HERE
+    end
+  end
+
+  def add_readme_header(header, iterpolation_values = {})
+    header_data = readme_header_data(header, iterpolation_values)
+    return if read_file("README.md").match("## #{header_data[:title]}")
+
+    if header_data[:body]
+      insert_into_readme do
+        <<-HERE.gsub(/^ {8}/, '')
+
+        ## #{header_data[:title]}
+
+        #{header_data[:body]}
+        HERE
+      end
+    else
+      insert_into_readme do
+        <<-HERE.gsub(/^ {8}/, '')
+
+        ## #{header_data[:title]}
+        HERE
+      end
+    end
+  end
+
+  def readme_header_data(header, iterpolation_values)
+    file = get_readme
+    header_data = file["readme"]["headers"][header.to_s]
+
+    {
+      title: header_data["title"],
+      body: interpolate_text(header_data["body"], iterpolation_values)
+    }
+  end
+
+  def readme_section_data(header, section, iterpolation_values)
+    file = get_readme
+    header_data = file["readme"]["headers"][header.to_s]
+    section_data = header_data["sections"][section.to_s]
+
+    {
+      header_title: header_data["title"],
+      title: interpolate_text(section_data["title"], iterpolation_values),
+      body: interpolate_text(section_data["body"], iterpolation_values)
+    }
+  end
+
+  def interpolate_text(text, iterpolation_values)
+    return unless text
+    b = binding
+    iterpolation_values.each { |k, v| singleton_class.send(:define_method, k) { v } }
+    ERB.new(text).result(b)
+  end
+
+  def get_readme
+    file = File.expand_path("../../assets/README.yml", __FILE__)
+    YAML.load(File.read(file))
+  end
+
+  def insert_into_readme(after_text = nil, &block)
+    if after_text
+      line = "#{after_text}\n"
+      insert_into_file "README.md", after: line do
+        block.call
+      end
+    else
+      append_to_file "README.md" do
+        block.call
+      end
+    end
+  end
+end

data/lib/potassium/{templates/application/helpers → helpers}/template-dsl.rb

@@ -4,14 +4,22 @@ module TemplateDSL
     require_relative './variable-helpers'
     require_relative './environment-helpers'
     require_relative './gem-helpers'
+    require_relative './docker-helpers'
     require_relative './callback-helpers'
+    require_relative './answer-helpers'
+    require_relative './info-helpers'
+    require_relative './readme-helpers'
 
     object.send :extend, TemplateHelpers
     object.send :extend, VariableHelpers
     object.send :extend, EnvironmentHelpers
     object.send :extend, GemHelpers
     object.send :extend, CallbackHelpers
+    object.send :extend, AnswerHelpers
+    object.send :extend, InfoHelpers
+    object.send :extend, ReadmeHelpers
 
     object.send :source_path, source_path
+    object.load_answers
   end
 end

data/lib/potassium/helpers/template-helpers.rb

@@ -0,0 +1,97 @@
+module TemplateHelpers
+  def app_name
+    @app_name || app_name_from_file
+  end
+
+  def load_recipe(recipe_name)
+    @recipes ||= {}
+    @recipes[recipe_name] ||= get_recipe_class(recipe_name.to_sym).new(self)
+  end
+
+  def create(recipe_name)
+    recipe = load_recipe(recipe_name)
+    recipe.create
+  end
+
+  def ask(recipe_name)
+    recipe = load_recipe(recipe_name)
+    recipe.ask
+  end
+
+  def install(recipe_name)
+    recipe = load_recipe(recipe_name)
+
+    if !recipe.respond_to?(:installed?) || !recipe.installed? || force?
+      recipe.install
+    else
+      info "#{recipe_name.to_s.titleize} is already installed"
+      info "Use --force to force the installation"
+    end
+  end
+
+  def eval_file(source)
+    location = File.expand_path(find_in_source_paths(source))
+    unique_name = SecureRandom.hex
+
+    define_singleton_method unique_name do
+      instance_eval File.read(location)
+    end
+
+    public_send unique_name
+  end
+
+  def source_path(path)
+    define_singleton_method :source_paths do
+      [File.expand_path(File.dirname(path))]
+    end
+  end
+
+  def erase_comments(file)
+    gsub_file file, /^\s*#[^\n]*\n/, ''
+  end
+
+  # TODO: Refactor to be able to reuse it and reduce the duplication and confusion.
+  def cut_comments(file, limit: 100)
+    gsub_file file, /^\s*#[^\n]*\n/ do |match|
+      if match.size > limit
+        match.partition(/[\w\W]{#{limit - 1}}/).reject(&:blank?).map do |line|
+          (line.size == limit - 1) ? "#{line}-" : "# #{line}"
+        end.join("\n")
+      else
+        match
+      end
+    end
+  end
+
+  def file_exist?(file_path)
+    File.exist?(file_path)
+  end
+
+  def dir_exist?(dir_path)
+    Dir.exist?(dir_path)
+  end
+
+  def read_file(file_path)
+    fail "#{file_path} does not exist in destination" unless file_exist?(file_path)
+    File.read(file_path)
+  end
+
+  def cli_options
+    self.class.cli_options
+  end
+
+  def force?
+    cli_options[:force]
+  end
+
+  private
+
+  def get_recipe_class(recipe_name)
+    require_relative "../recipes/#{recipe_name}"
+    Recipes.const_get(recipe_name.to_s.camelize)
+  end
+
+  def app_name_from_file
+    File.read('config/application.rb').match(/module\s(.*)/)[1].underscore.dasherize
+  end
+end

data/lib/potassium/recipe.rb

@@ -0,0 +1,2 @@
+module Recipes
+end

data/lib/potassium/{templates/application/recipes → recipes}/admin.rb

@@ -1,12 +1,43 @@
-if selected?(:admin_mode)
-  if selected?(:authentication, :devise)
+class Recipes::Admin < Rails::AppBuilder
+  def ask
+    if selected?(:authentication)
+      admin_mode = answer(:admin) { Ask.confirm("Do you want to use ActiveAdmin?") }
+      set(:admin_mode, admin_mode)
+    end
+  end
+
+  def create
+    if selected?(:admin_mode)
+      if selected?(:authentication)
+        add_active_admin
+      else
+        info "ActiveAdmin can't be installed because Devise isn't enabled."
+      end
+    end
+  end
+
+  def install
+    devise = load_recipe(:devise)
+    if devise.installed?
+      add_active_admin
+    else
+      info "ActiveAdmin can't be installed because Devise isn't installed."
+    end
+  end
+
+  def installed?
+    gem_exists?(/activeadmin/)
+  end
+
+  private
+
+  def add_active_admin
     gather_gem 'activeadmin', github: 'activeadmin'
     gather_gem 'activeadmin_addons'
     gather_gem 'active_skin'
 
     after(:gem_install, wrap_in_action: :admin_install) do
       generate "active_admin:install"
-
       line = "ActiveAdmin.setup do |config|"
       initializer = "config/initializers/active_admin.rb"
       gsub_file initializer, /(#{Regexp.escape(line)})/mi do |_match|
@@ -24,7 +55,6 @@ if selected?(:admin_mode)
 
       line = "@import \"active_admin/base\";"
       style = "app/assets/stylesheets/active_admin.css.scss"
-
       style = File.exist?(style) ? style : "app/assets/stylesheets/active_admin.scss"
 
       gsub_file style, /(#{Regexp.escape(line)})/mi do |_match|
@@ -38,8 +68,8 @@ if selected?(:admin_mode)
            @import "active_skin";
            HERE
       end
+
+      generate "activeadmin_addons:install"
     end
-  else
-    say "ActiveAdmin can't be installed because Devise isn't enabled.", :red
   end
 end