francis 0.0.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f74c91f9218cf3c3236ec871f13c213955788fac080a658486143251617bb04
+  data.tar.gz: 3b3e6df458522097ecff512084e7ba0dd827fed1d74d33a297c7de612cc10f96
+SHA512:
+  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.dispatch(command, args)
+Francis::CLI.start(ARGV)

data/lib/francis.rb

@@ -1,75 +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
+require 'thor'
 
-# This is the only and main class for the gem.
+module Francis
 
-class Francis
-  @@folders = ["app","tmp","db","public","views","public/css","public/js","public/img"]
-  @@files = ["app/app.rb", "db/db.rb", "tmp/restart.txt", "Gemfile","config.ru"]
-  
-  # Determines which method to call.
-  def self.dispatch(command, args)
-    case command
-     when 'new'
-       Francis.new(args[0],args[1..-1])
-     when 'folders'
-       Francis.folders
-     when 'files'
-       Francis.files
-     else
-       Francis.help
+  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
-  
-  # Creates a new working directory for Sinatra apps, 
-  # it takes two variables: a name to call the directory 
-  # and an option array.
-  def self.new(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'")
+    def parse_options
+      git
+      readme
+      unicorn
+      whenever
+      require_gem
     end
-    File.open("app/app.rb","a") do |f|
-      f.write("get '/' do\n  'Hello world!'\nend")
+    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("config.ru","a") do |f|
-      f.write("require 'bundler'\nBundler.require\nrequire './app/app'\nrequire './db/db'\nrun Sinatra::Application")
+    def git
+      if @options[:git]
+        @structure["/"][".gitignore"] = %Q(.DS_Store\nGemfile.lock\npids/*\nlogs/*\n*.gem)
+      end
     end
-    if options.include?("--git")
-      system("git init")
+    def readme
+      if @options[:readme]
+        @structure["/"]["readme.md"] = %Q(# #{@name.capitalize}\n\nTODO: Write a readme file)
+      end
+    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
+    def whenever
+      if @options[:whenever]
+        add_folder "/config"
+        @structure["/config"]["schedule.rb"] = ""
+      end
+    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
+    def add_folder(folder)
+      if !@structure.has_key?(folder)
+        @structure["#{folder}"] = {}
+      end
     end
-    puts "Sinatra app '#{name}' created!"
-  end
-  
-  # Prints the folders that are included in the directory 
-  # set up.
-  def self.folders
-    puts @@folders
-  end
-  
-  # Prints the files that are included in the directory 
-  # set up.
-  def self.files
-    puts @@files
-  end
-  
-  # Prints the help file.
-  def self.help
-    puts "Usage:\n\nfrancis new <appname> [--git]\n\nCreates a new Sinatra app.\n\n<appname> => Name of the new directory\n\n--git => If present, will set the new directory up as a git repository\n\nfrancis folders\n\nPrints a list of folders that are created when francis new is run.\n\nfrancis files\n\nPrints a list of files that are created when francis new is run."
   end
-end
+end

metadata

@@ -1,47 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: francis
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Ian Kent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
-dependencies: []
-description: A quick start for Sinatra apps
+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:
 - francis
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/francis.rb
 - bin/francis
-homepage: http://code.iankent.me/francis
-licenses: []
+- lib/francis.rb
+homepage: https://bitbucket.org/iankentforrestbrown/francis/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Francis
 test_files: []