pineapples 0.1.0 → 0.3.34

data/lib/pineapples/actions/ruby.rb

@@ -0,0 +1,49 @@
+require_relative 'shell'
+module Pineapples
+  module Actions
+    # Executes a ruby script (taking into account WIN32 platform quirks).
+    #
+    # ==== Parameters
+    # command<String>:: the command to be executed.
+    # options<Hash>:: give :verbose => false to not log the status.
+    #
+    def ruby(command, options = {})
+      return if behaviour != :inboke
+      shell(command, options.merge(with: ruby_command))
+    end
+
+    private
+    # Return the path to the ruby interpreter taking into account multiple
+    # installations and windows extensions.
+    #
+    def ruby_command # rubocop:disable MethodLength
+      @ruby_command ||= begin
+        ruby_name = RbConfig::CONFIG['ruby_install_name']
+        ruby = File.join(RbConfig::CONFIG['bindir'], ruby_name)
+        ruby << RbConfig::CONFIG['EXEEXT']
+
+        # avoid using different name than ruby (on platforms supporting links)
+        if ruby_name != 'ruby' && File.respond_to?(:readlink)
+          begin
+            alternate_ruby = File.join(RbConfig::CONFIG['bindir'], 'ruby')
+            alternate_ruby << RbConfig::CONFIG['EXEEXT']
+
+            # ruby is a symlink
+            if File.symlink? alternate_ruby
+              linked_ruby = File.readlink alternate_ruby
+
+              # symlink points to 'ruby_install_name'
+              ruby = alternate_ruby if linked_ruby == ruby_name || linked_ruby == ruby
+            end
+          rescue NotImplementedError # rubocop:disable HandleExceptions
+            # just ignore on windows
+          end
+        end
+
+        # escape string in case path to ruby executable contain spaces.
+        ruby.sub!(/.*\s.*/m, '"\&"')
+        ruby
+      end
+    end
+  end
+end

data/lib/pineapples/actions/shell.rb

@@ -0,0 +1,40 @@
+module Pineapples
+  module Actions
+    # Executes a command returning the contents of the command.
+    #
+    # ==== Parameters
+    # command<String>:: the command to be executed.
+    # options<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
+    #                to append an executable to command execution.
+    #
+    # ==== Example
+    #
+    #   inside 'vendor' do
+    #     shell 'ln -s ~/edge rails'
+    #   end
+    #
+    def shell(command, options = {})
+      return if behavior == :revoke
+
+      verbose = options.fetch(:verbose, verbose?)
+      execute = !options.fetch(:pretend, pretend?)
+
+      description = "#{command} from #{current_app_dir.inspect}"
+
+      executable = options[:with].to_s
+
+      if executable.present?
+        description = "#{File.basename(executable)} #{desc}"
+        command = "#{executable} #{command}"
+      end
+
+      say_action(:shell, description, verbose)
+
+      if execute
+        config[:capture] ? `#{command}` : system("#{command}")
+        raise Error, "#{command} failed with status #{$CHILD_STATUS.exitstatus}." if not $CHILD_STATUS.success?
+      end
+    end
+
+  end
+end

data/lib/pineapples/actions/template.rb

@@ -0,0 +1,35 @@
+require 'erb'
+
+module Pineapples
+  module Actions
+    # Gets an ERB template at the relative source, executes it and makes a copy
+    # at the relative destination. If the destination is not given it's assumed
+    # to be equal to the source removing .tt from the filename.
+    #
+    # ==== Parameters
+    # source<String>:: the relative path to the source root.
+    # target<String>:: the relative path to the destination root.
+    # options<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   template "README", "doc/README"
+    #
+    #   template "doc/README"
+    #
+    def template(source, *args, &block)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      target = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, '')
+
+      source  = File.expand_path(find_in_source_paths(source.to_s))
+      context = options.delete(:context) || binding #instance_eval('binding')
+
+      create_file(target, nil, options) do
+        template = File.binread(source)
+        content = ERB.new(template, nil, '-').result(context)
+        content = block.call(content) if block
+        content
+      end
+    end
+  end
+end

data/lib/pineapples/actions.rb

@@ -1,39 +1,124 @@
-module Pineapples
-  module Actions
-    def replace_file(relative_path, *args)
-      remove_file(relative_path)
-      copy_file(relative_path, *args)
-    end
-
-    def replace_in_file(relative_path, find, replace)
-      path = File.join(destination_root, relative_path)
-      contents = IO.read(path)
-      unless contents.gsub!(find, replace)
-        raise "#{find.inspect} not found in #{relative_path}"
-      end
-      File.open(path, "w") { |file| file.write(contents) }
-    end
-
-    def action_mailer_host(rails_env, host)
-      config = "config.action_mailer.default_url_options = {host: #{host}}"
-      configure_environment(rails_env, config)
-    end
-
-    def configure_application_file(config)
-      inject_into_file(
-        "config/application.rb",
-        "\n\n    #{config}",
-        before: "\n  end"
-      )
-    end
-
-    def configure_environment(rails_env, config)
-      inject_into_file(
-        "config/environments/#{rails_env}.rb",
-        "\n\n  #{config}",
-        before: "\nend"
-      )
-    end
-
-  end
-end
+require 'fileutils'
+require 'pathname'
+require 'uri'
+require 'pineapples/actions/base/action'
+require 'pineapples/actions/base/target'
+require 'pineapples/actions/apply'
+require 'pineapples/actions/chmod'
+require 'pineapples/actions/copy_file'
+require 'pineapples/actions/create_file'
+require 'pineapples/actions/directory'
+require 'pineapples/actions/empty_directory'
+require 'pineapples/actions/get'
+require 'pineapples/actions/git'
+require 'pineapples/actions/gsub_file'
+require 'pineapples/actions/insert_into_file'
+require 'pineapples/actions/inside'
+require 'pineapples/actions/keep_file'
+require 'pineapples/actions/prepend_to_class'
+require 'pineapples/actions/remove_file'
+require 'pineapples/actions/ruby'
+require 'pineapples/actions/shell'
+require 'pineapples/actions/template'
+
+require 'pineapples/actions/rails/rails'
+
+module Pineapples
+  module Actions
+    TEMPLATE_EXTNAME = '.tt'
+
+    DEFAULT_COLOR = :light_green
+
+    attr_reader :behaviour
+
+    def initialize(options)
+      super
+
+      @behaviour = options.behaviour || :invoke
+    end
+
+    # Executes instance of Action subclass depending on generator behaviour
+    def action(instance) #:nodoc:
+      return if instance.skip?
+      if behaviour == :invoke
+        instance.invoke!
+      else
+        instance.revoke!
+      end
+    end
+
+    def templates_root
+      @templates_root ||= File.join(__dir__, 'templates')
+    end
+
+    def source_paths
+      @source_paths ||= []
+    end
+
+    def source_paths_for_search
+      paths = []
+      paths += source_paths
+      paths << templates_root if templates_root
+      paths
+    end
+
+    # dir argument must me absolute path
+    def relative_to_app_root(dir)
+      @app_root_pathname ||= Pathname.new(app_root)
+      path = Pathname.new(dir)
+      path.relative_path_from(@app_root_pathname).to_s
+    end
+
+    def relative_to_current_app_dir(dir)
+      current_app_path = Pathname.new(current_app_dir)
+      path = Pathname.new(dir)
+      path.relative_path_from(current_app_path).to_s
+    end
+
+    def find_in_source_paths(file)
+      files_to_search = [file, file + TEMPLATE_EXTNAME]
+      sources = source_paths_for_search
+
+      sources.each do |source_path|
+        files_to_search.each do |file|
+          source_file = File.expand_path(file, source_path)
+          return source_file if File.exist?(source_file)
+        end
+      end
+
+      message = "Could not find #{file.inspect} in any of your source paths. "
+
+      unless self.templates_root
+        message << "Please set your generator instance template_root to PATH with the PATH containing your templates."
+      end
+
+      if sources.empty?
+        message << "Currently you have no source paths."
+      else
+        message << "Your current source paths are: \n#{sources.join("\n")}"
+      end
+
+      raise Error, message
+    end
+
+    def say_status(status, message, color = :light_green, log = true)
+      return if !log
+
+      spaces = ' ' * $terminal.indent_size * 2
+
+      status = status.to_s.rjust(12)
+      status = status.colorize(color)
+
+      output = "#{status}#{spaces}#{message}"
+
+      say(output)
+    end
+
+    def indent(verbose = true, level_increment = 1)
+      $terminal.indent_level += level_increment if verbose
+      yield
+      $terminal.indent_level -= level_increment if verbose
+    end
+
+  end
+end

data/lib/pineapples/app_builder.rb

@@ -0,0 +1,70 @@
+require 'pineapples/actions'
+#require 'pineapples/build_tasks/root_files'
+
+module Pineapples
+  class AppBuilder
+    include Pineapples::Actions
+
+    def root_files
+      create_file '.ruby-version', "#{Pineapples::RUBY_VERSION}\n"
+      create_file '.ruby-gemset', app_name
+
+      template  'config.ru'
+      template  'Gemfile'
+      copy_file 'Guardfile'
+      copy_file 'Procfile'
+      copy_file 'Rakefile'
+
+      copy_file '.gitignore'
+
+      template  'README.md.tt'
+      copy_file 'browserlist'
+      copy_file '.editor-config'
+
+      template  '.example.env.tt'
+
+      if options.heroku?
+        copy_file '.buildpacks'
+        template 'Aptfile'
+      end
+
+      if !options.skip_test?
+        copy_file '.example.rspec'
+      end
+    end
+
+    def app_files
+      directory 'app', except: 'user.rb'
+
+      inside 'app' do
+        keep_file 'assets/fonts'
+        keep_file 'assets/images'
+        if create_user_model?
+          template 'models/user.rb.tt'
+        else
+          keep_file 'models'
+        end
+        keep_file 'mailers'
+
+        keep_file 'controllers/concerns'
+        keep_file 'models/concerns'
+      end
+
+    end
+
+    def bin_files
+      directory 'bin' do |content|
+        "#{shebang}\n" + content
+      end
+      chmod 'bin', 0755 & ~File.umask, verbose: false
+    end
+
+    def config_files
+      directory 'config'
+
+      inside 'config' do
+      end
+    end
+
+  end
+end

data/lib/pineapples/app_generator.rb

@@ -0,0 +1,187 @@
+require 'pineapples/actions'
+require 'pineapples/helpers'
+require 'pineapples/settings'
+
+module Pineapples
+  class AppGenerator
+    extend Pineapples::Settings
+    prepend Pineapples::Actions
+    include Pineapples::Actions::Rails
+    include Pineapples::Helpers
+
+    TEMPLATING_ENGINES = [:erb, :haml, :slim]
+
+    setting :heroku, type: :boolean, default: false,
+            prompt: 'Wanna use Heroku?'
+
+    setting :carrierwave, type: :boolean, default: false,
+            prompt: 'Wanna use Carrierwave for file uploads?'
+
+    setting :devise, type: :boolean, default: true,
+            prompt: 'Wanna use Devise for authentication?'
+
+    setting :ajax_login, type: :boolean, default: false,
+            prompt: 'Wanna login via ajax using devise?'
+
+    setting :pundit, type: :boolean, default: true,
+            prompt: 'Wanna use Pundit for authorization?'
+
+    setting :user_role_field, type: :boolean, default: true,
+            prompt: 'Wanna add role attribute to users model as simple user roles solution?'
+
+    setting :template_engine, type: :symbol, default: :erb, options: TEMPLATING_ENGINES,
+            prompt: 'Select templating engine to be used in the app'
+
+    setting :bootstrap, type: :boolean, default: false,
+            prompt: 'Wanna use Bootstrap on this project?'
+
+    attr_accessor :app_name,
+                  :app_root,
+                  :settings
+
+    def initialize(options)
+      @app_name = options.app_name.gsub(/\s+/, '-')
+      @app_root = options.app_root || File.expand_path(app_name)
+      @debug = options.debug || false
+      @pretend = options.pretend || false
+      @verbose = options.verbose || true
+
+      @settings = self.class.settings
+    end
+
+    def start!
+      valid_const! && check_target!
+      create_app_root
+
+      # ask_user_settings
+
+      create_root_files
+      create_app_files
+      create_bin_files
+      create_config_files
+      create_db_files
+      create_lib_files
+      create_public_files
+      create_spec_files
+
+      create_misc_folders
+
+      #run_after_bundle_callbacks
+    rescue Pineapples::Error => error
+      (debug? || ENV['PINEAPPLES_DEBUG'] == '1') ? (raise error) : say(error.message.light_red)
+      exit 1
+    end
+
+    def ask_user_settings
+      settings[:heroku].ask_setting
+      settings[:template_engine].ask_setting
+    end
+
+    def create_root_files
+      copy_file '.editor-config'
+      template '.example.env'
+      copy_file '.example.rspec'
+      copy_file '.gitignore'
+      copy_file 'browserlist'
+      template 'config.ru'
+      template 'Gemfile'
+      copy_file 'Guardfile'
+      copy_file 'Procfile'
+      copy_file 'Rakefile'
+      template 'README.md', 'README.md'
+      if heroku?
+        copy_file '.buildpacks'
+        copy_file 'Aptfile'
+      end
+    end
+
+    def create_app_files
+      directory 'app'
+      keep_file  'app/assets/fonts'
+      keep_file  'app/assets/images'
+
+      keep_file  'app/mailers'
+      keep_file  'app/models' if !needs_user_model?
+    end
+
+    def create_bin_files
+      directory 'bin'
+      # chmod 'bin', 0755 & ~File.umask, verbose: false
+    end
+
+    def create_config_files
+      directory 'config'
+    end
+
+    def create_db_files
+      empty_directory 'db/migrate'
+      copy_migration 'enable_postgres_extensions'
+      copy_migration 'create_data_migrations'
+      if devise?
+        copy_migration 'devise_create_users'
+        copy_migration 'add_role_field_to_users' if user_role_field?
+      end
+    end
+
+    def create_lib_files
+      directory 'lib'
+      keep_file 'lib/assets'
+    end
+
+    def create_public_files
+      directory 'public'
+    end
+
+    def create_spec_files
+      # directory 'spec'
+    end
+
+    def create_misc_folders
+      keep_file 'log'
+
+      empty_directory 'tmp/cache/assets'
+
+      inside 'vendor/assets' do
+        keep_file 'javascripts'
+        keep_file 'stylesheets'
+      end
+    end
+
+    def run_after_bundle_callbacks
+      @after_bundle_callbacks.each(&:call)
+    end
+
+
+
+    def debug?
+      @debug
+    end
+
+    def pretend?
+      @pretend
+    end
+
+    def execute?
+      !pretend?
+    end
+
+    def verbose?
+      @verbose
+    end
+
+    protected
+
+    def create_app_root
+      FileUtils::mkdir_p(app_root)
+      say_status :create_root, 'Created application root'
+    end
+
+    def check_target!
+      if Dir["#{app_root}/*"].present?
+        puts "I won't grow pineapples there, the target directory isn't empty."
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/pineapples/build_tasks/root_files.rb

@@ -0,0 +1,23 @@
+module Pineapples
+  module BuildTasks
+    module RootFiles
+      def readme
+      end
+
+      def rakefile
+      end
+
+      def configru
+      end
+
+      def gitignore
+      end
+
+      def gemfile
+      end
+
+      # build(:) if !options.skip_git?
+      # build(:gemfile)   if !options.skip_gemfile?
+    end
+  end
+end

data/lib/pineapples/error.rb

@@ -0,0 +1,7 @@
+module Pineapples
+  class Error < StandardError
+  end
+
+  class SkipActionError < StandardError
+  end
+end

data/lib/pineapples/helpers.rb

@@ -0,0 +1,34 @@
+module Pineapples
+  module Helpers
+    RESERVED_NAMES = %w[application destroy plugin runner test]
+
+    def needs_user_model?
+      user_role_field? || devise?
+    end
+
+    protected
+
+    def app_const_base
+      @app_const_base ||= app_name.gsub(/\W/, '_').squeeze('_').camelize
+    end
+
+    def app_const
+      @app_const ||= "#{app_const_base}::Application"
+    end
+
+    def valid_const!
+      if app_const =~ /^\d/
+        raise Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
+      elsif RESERVED_NAMES.include?(app_name)
+        raise Error, "Invalid application name #{app_name}. Please give a name which does not match one of the reserved rails words."
+      elsif Object.const_defined?(app_const_base)
+        raise Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
+      end
+    end
+
+    def app_secret
+      SecureRandom.hex(64)
+    end
+
+  end
+end

data/lib/pineapples/parser.rb

@@ -0,0 +1,37 @@
+module Pineapples
+  class Parser
+    def self.parse(args)
+      options = OpenStruct.new
+      options.app_name = nil
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: pineapples [options] NEW_APP_DIRECTORY'
+
+        opts.on('-h', '--help', 'Show pineapples usage') do
+          self.usage_and_exit(opts)
+        end
+
+        opts.on_tail('-v', '--version', 'Show version') do
+          puts Pineapples::VERSION
+          exit 1
+        end
+      end
+
+      begin
+        parser.parse!
+        options.app_name = ARGV.first
+
+        raise OptionParser::InvalidOption if options.app_name.nil?
+
+        options
+      rescue OptionParser::InvalidOption
+        self.usage_and_exit(parser)
+      end
+    end
+
+    def self.usage_and_exit(parser)
+      say parser
+      exit 1
+    end
+  end
+end