francis 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1b4d040d1adc0b565872ed025acdc501ccaa8ee55d5554765c33a1fd3a758f
-  data.tar.gz: b8510bb2fa5aed08c0a552b8817ef361c02115159bb1e884a6ee094057eaadbd
+  metadata.gz: 7f74c91f9218cf3c3236ec871f13c213955788fac080a658486143251617bb04
+  data.tar.gz: 3b3e6df458522097ecff512084e7ba0dd827fed1d74d33a297c7de612cc10f96
 SHA512:
-  metadata.gz: b0fd9dd66fc727614fa511d5da0a0648f6fc5985b39ad0e3a683ad381313a190c4fa11ceaa76bce4fdc885f8b41c6fd65a11aee9016c5ccd9a87e3ff1e594ee7
-  data.tar.gz: 4e7397f747fbd4f39c661635851690bea0ae9ec0b1e6a90ee8db5a991f1bc2da57a25c40a8a2207c9b798011f0caf142fd00ac57ce565f1edefcd7d7e191a211
+  metadata.gz: 2be6192cc9991c6430b5caa8aab21d4e34988b42e1de0600eb63f9d6d655ee71620873b727b651da60d479d0d887938a885ccbe095a52b0c3f0d3e3c4f923f05
+  data.tar.gz: 35144bcf547123a1df2bb1aa0bb725e580005e7c0865ac627ff0d5be98eb6bded53e4b6fb1b27086e6a19419ba02d56eae340831007f428249fc615e3daa6475

data/bin/francis

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
 require 'francis'
-args = ARGV.dup
-ARGV.clear
-command = args.shift.strip
-Francis.new(command, args)
+Francis::CLI.start(ARGV)

data/lib/francis.rb

@@ -1,149 +1,112 @@
-# A simple gem & CLI for setting up a working directory
-# structure for Sinatra apps.
-#
-# Author:: Ian Kent (mailto:ian@iankent.me)
-# License:: Distributed under the same terms as Ruby
-
-# This is the only and main class for the gem.
-
-class Francis
-
-
-  attr_accessor :folders, :files, :newhelp, :foldershelp, :fileshelp
-
-  # Creates a new instance of the class and directs the gem
-  # to the method based on the command passed to it.
-  def initialize(command, args)
-    @folders = ["app","public","views"]
-    @files = ["app/app.rb", "Gemfile","config.ru"]
-    @newhelp = %Q(
-      Usage:
-
-      francis new <appname> [--git][--proc][--readme][--unicorn][-r <gems>]
-
-      Creates a new Sinatra app.
-
-      <appname> => Name of the new directory
-
-      Options:
-
-      --git => sets up the directory up as a git repo
-      --proc => sets up the directory with a Procfile
-      --readme => sets up the directory with a readme.md
-      --unicorn => sets up the directory with config/unicorn.rb, pids/unicorn.pid and logs/unicorn.log
-      -r <gems> => adds gems to the Gemfile
-    )
-
-    @foldershelp = %Q(
-      francis folders
-
-      Prints a list of folders that are created when francis new is run.
-    )
-    @fileshelp = %Q(
-      francis files
-
-      Prints a list of files that are created when francis new is run.
-    )
-    case command
-     when 'new'
-       run(args[0],args[1..-1])
-     when 'folders'
-       puts folders
-     when 'files'
-       puts files
-     when 'help'
-       help(args)
-     else
-       puts "I don't understand"
+require 'thor'
+
+module Francis
+
+  class CLI < Thor
+    desc "create NAME", "Create a new sinatra app called NAME"
+    option :git, :type => :boolean, :aliases => "-g", :desc => "Create app as a git respository and include a .gitignore file"
+    option :readme, :type => :boolean, :aliases => "-R", :desc => "Include a readme.md file"
+    option :unicorn, :type => :boolean, :aliases => "-u", :desc => "Include a config/unicorn.rb file with default unicorn config"
+    option :require_gem, :type => :array, :aliases => "-r", :desc => "Add required gems that will be included in the Gemfile and required within app.rb"
+    option :whenever, :type => :boolean, :aliases => "-w", :desc => "Include a config/schedule.rb file"
+    def create(name)
+      Francis::FileStructure.new(name, options)
     end
   end
-
-  # Main run method, this will create the working directory
-  # and add any further files and folders based on the options passed to it.
-  def run(name, options)
-    dir = Dir.getwd
-    if Dir.exists?("#{dir}/#{name}")
-      abort("There is already a folder with that name, please choose another.")
-    else
-      Dir.mkdir("#{dir}/#{name}")
+  class FileStructure
+    def initialize(name, options)
+      @name = name
+      sinatra_gem_version = Gem.latest_version_for 'sinatra'
+      @structure = {
+        "/views" => {},
+        "/public" => {},
+        "/" => {
+          "config.ru" => %Q(require 'bundler'\nBundler.require\nrequire_relative 'app'\nrun #{@name.capitalize}),
+          "app.rb" => %Q(require 'sinatra'\nclass #{@name.capitalize} < Sinatra::Base\n\tget '/' do\n\t\t'Hello world!'\n\tend\nend),
+          "Gemfile" => %Q(source 'https://rubygems.org'\ngem 'sinatra', '#{sinatra_gem_version.approximate_recommendation}'\n)
+        }
+      }
+      @options = options
+      @wd = "#{Dir.getwd}/#{@name}"
+      parse_options
+      execute!
     end
-    Dir.chdir("#{dir}/#{name}")
-    folders.each do |f|
-      Dir.mkdir(f)
+    def add_folder(name)
+      @structure["/#{name}"] = {}
     end
-    files.each do |f|
-      File.new(f,"w")
+    def remove_folder(name)
+      @structure.delete("/#{name}"){|el| "#{el} not found"}
     end
-    File.open("Gemfile","a") do |f|
-      f.write("source 'https://rubygems.org'\ngem 'sinatra'\n")
+    def parse_options
+      git
+      readme
+      unicorn
+      whenever
+      require_gem
     end
-    if options.include?("--proc")
-      File.open("Procfile","a") do |f|
-        f.write("web: bundle exec rackup config.ru -p $PORT")
+    def execute!
+      # create target directory
+      Dir.mkdir(@wd)
+      # cycle through structure and create folders and files
+      @structure.each{|folder,files|
+        if folder != "/"
+          Dir.mkdir("#{@wd}#{folder}")
+        end
+        files.each{|name,contents|
+          File.open("#{@wd}#{folder}/#{name}", "w"){|f|
+            f.write(contents)
+          }
+        }
+      }
+      # if git option is given, execute git init command
+      if @options[:git]
+        Dir.chdir(@wd)
+        system "git init"
       end
+      puts "#{@name} created as Sinatra app"
     end
-    File.open("app/app.rb","a") do |f|
-      f.write("get '/' do\n  'Hello world!'\nend")
-    end
-    File.open("config.ru","a") do |f|
-      f.write("require 'bundler'\nBundler.require\nrequire './app/app'\nrequire './db/db'\nrun Sinatra::Application")
-    end
-    if options.include?("--git")
-      system("git init")
+    def git
+      if @options[:git]
+        @structure["/"][".gitignore"] = %Q(.DS_Store\nGemfile.lock\npids/*\nlogs/*\n*.gem)
+      end
     end
-    if options.include?("--readme")
-      File.open("README.md","a") do |f|
-        f.write("# #{name.upcase}")
+    def readme
+      if @options[:readme]
+        @structure["/"]["readme.md"] = %Q(# #{@name.capitalize}\n\nTODO: Write a readme file)
       end
     end
-    if options.include?("-r")
-      gems = options.select { |a| a[0] != "-" }
-      File.open("Gemfile","a") do |f|
-        gems.each do |g|
-          f.write("gem '#{g}'\n")
-        end
+    def unicorn
+      if @options[:unicorn]
+        add_folder "/config"
+        add_folder "/pids"
+        add_folder "/logs"
+        @structure["/config"]["unicorn.rb"] = %Q(working_directory '#{@wd}'\npid '#{@wd}/pids/unicorn.pid'\nstderr_path '#{@wd}/logs/unicorn.log'\nstdout_path '#{@wd}/logs/unicorn.log'\nlisten '/tmp/#{@name}.sock'\nworker_processes 2\ntimeout 30)
+        @structure["/pids"]["unicorn.pid"] = ""
+        @structure["/logs"]["unicorn.log"] = ""
       end
     end
-    if options.include?("--unicorn")
-      ["config", "pids", "logs"].each do |f|
-        Dir.mkdir(f)
+    def whenever
+      if @options[:whenever]
+        add_folder "/config"
+        @structure["/config"]["schedule.rb"] = ""
       end
-      File.open("config/unicorn.rb","a") do |f|
-        f.write %Q(
-          app_path = File.expand_path(File.dirname(__FILE__) + '/..')
-          working_directory app_path
-          pid app_path + "/pids/unicorn.pid"
-          stderr_path app_path + "/logs/unicorn.log"
-          stdout_path app_path + "/logs/unicorn.log"
-          listen "/tmp/unicorn.#{Dir.pwd}.sock"
-          worker_processes 2
-          timeout 60
-        )
+    end
+    def require_gem
+      if @options[:require_gem]
+        @options[:require_gem].each{|r|
+          version = Gem.latest_version_for(r)
+          if version
+            @structure["/"]["Gemfile"] << %Q(gem '#{r}', '#{version.approximate_recommendation}'\n)
+          else
+            warn "Could not find gem: #{r}, skipping inclusion in Gemfile"
+          end
+        }
       end
-
     end
-
-    puts "Sinatra app '#{name}' created!"
-  end
-
-
-  # Prints the help file.
-  def help(*method)
-    if method.empty?
-      puts newhelp + foldershelp + fileshelp
-    elsif method.length == 1
-      case method[0][0]
-      when "new"
-        puts newhelp
-      when "folders"
-        puts foldershelp
-      when "files"
-        puts fileshelp
-      else
-        puts newhelp + foldershelp + fileshelp
+    def add_folder(folder)
+      if !@structure.has_key?(folder)
+        @structure["#{folder}"] = {}
       end
-    else
-      puts newhelp + foldershelp + fileshelp
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: francis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ian Kent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
-dependencies: []
+date: 2021-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: A command line tool for quickly setting up Sinatra apps
 email: ian@iankent.me
 executables: