camping 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69707262bf525f5cb135dbfeaa2a409bc6a3a49898cb40822028b4b5adac0a09
-  data.tar.gz: b94ce5a9963004b6df3a5b3908bbc9fb2b447f7538d53ae6ec22f31e7ba7f7bc
+  metadata.gz: afe5fa876178ba1acb276392788f76f4df3451c8b212234892565b6cd93043b0
+  data.tar.gz: c521c1b9e5c149474a4590efbc17fe61bd681bc79e510441bf1bd572e6505351
 SHA512:
-  metadata.gz: 8c49b9463466def77e63a75ec463e8bc037f05594045a14373746cbcb728dedf30fc2905748c22da83c2158fda14548546edbc8f47436aaafd41e9791b801031
-  data.tar.gz: 3ccb7f67bba7eedc533a91d8cde7b3381cb5b66b44e83dd57fce50051d03ada4fc8d30ea491e655b8e50cd86c4766d61d210195c605f2b4b2766f3213cdfd1e4
+  metadata.gz: 7c77c29289f3e917c182178a3c0593f4d5b0ae3352a08fde92a4787ec6d4b98330108fe37860cf73f45896b37d32235918fafe123f674ba93088aeb1760958a3
+  data.tar.gz: 8b95dff758b4fb8adac1704bce9de1980c50ee25a8c1bf8492e3cbc9d847cde87b131e24329fea495ab4e4ec62925ba578f3c30a9c17b9aae7514038d57f79b7

data/README.md

@@ -64,27 +64,38 @@ end
 ## Installation
 
 Interested yet?  Luckily it's quite easy to install Camping.  We'll be using
-a tool called RubyGems, so if you don't have that installed yet, go grab it!
-Once that's sorted out, open up a Terminal or Command Line and enter:
+a tool called RubyGems, and Bundler, so if you don't have that installed
+yet, go grab it! Once that's sorted out, open up a Terminal or Command
+Line and enter:
 
 ```
 gem install camping
 ```
 
+Also make certain to have Bundler installed:
+
+```
+gem install bundler
+```
+
 ~~Even better, install the Camping Omnibus, a full package of recommended libs:~~ Camping Omnibus will return for summer vacation.
 
+Now make a new directory filled with your camp essentials using the `camping new` command:
+
+```
+camping new Donuts # You can replace Donuts with whatever but CamelCased.
+```
+
+Move to your new directory, then use bundler to install all of your camp's dependencies:
+
 ```
-gem install camping-omnibus
+cd donuts; bundle install
 ```
 
-If not, you should be aware of that Camping itself only depends on
-[Rack](https://github.com/rack/rack), and if you're going to use the views you also
-need to install **[markaby](https://github.com/markaby/markaby)**, and if you're going to use the database you need
-**activerecord** as well.
+You can now run camping using the `camping` command. We recommend running camping in development mode locally. Make certain to prefix the camping command with `bundle exec` to run your app with the gems you've installed just for your camp:
 
 ```
-gem install markaby
-gem install activerecord
+bundle exec camping -e development
 ```
 
 ## Learning

data/Rakefile

@@ -70,6 +70,18 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/app_*.rb', 'test/gear/gear_*.rb']
 end
 
+## Reloader Tests
+Rake::TestTask.new(:reloader) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/reload_*.rb']
+end
+
+## Reloader Tests
+Rake::TestTask.new(:configreloader) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/config_*.rb']
+end
+
 ## Diff
 desc "Compare camping and camping-unabridged"
 task :diff do
@@ -97,7 +109,7 @@ end
 error = false
 
 ## Check
-task :check => ["test", "check:valid", "check:equal", "check:size", "check:lines", "check:exit"]
+task :check => ["test", "reloader", "configreloader", "check:valid", "check:equal", "check:size", "check:lines", "check:exit"]
 namespace :check do
 
   desc "Check source code validity"

data/lib/camping/campguide.rb

@@ -0,0 +1,14 @@
+# Campguide is a small helper to map common errors in a Camping project to a quick resolution.
+module Campguide
+	Errors = {"wrong number of arguments (given 3, expected 0)" => "ArgumentError. This is sometimes caused when you try to send a request to a controller when a camping app hasn't made camp yet. make certain to call Camping.make_camp to set up your apps."}
+
+	class << self
+
+		# accepts string error messages and tries to match them with better explanations of the error.
+		def make_sense(error_message)
+			message = Errors[error_message]
+			puts message ? message : error_message
+		end
+
+	end
+end

data/lib/camping/commands.rb

@@ -11,6 +11,25 @@ module Camping
       downcase
     end
 
+    # transform app_name to camel Case
+    def self.to_camel_case(string)
+      cammelled = ""
+      to_snake_case(string).split("_").each do |seq|
+        cammelled << seq.capitalize
+      end
+      cammelled
+    end
+
+    # Helper method that generates an app name from command line input.
+    def self.app_name_from_input(app_name)
+      app_name = :Camp if app_name == nil
+      app_name = app_name.to_sym if app_name.class == String
+      snake_app_name = to_snake_case(app_name)
+      camel_app_name = to_camel_case(snake_app_name)
+
+      {app_name: camel_app_name.to_sym, snake_name: snake_app_name, camel_name: camel_app_name}
+    end
+
     RouteCollection = Struct.new(:routes)
     class RouteCollection
       # Displays formatted routes from a route collection
@@ -218,9 +237,79 @@ task :test => 'test:all'
 namespace 'test' do
   Rake::TestTask.new('all') do |t|
     t.libs << 'test'
-    t.test_files = FileList['test/nuts_*.rb']
+    t.test_files = FileList['test/test_*.rb']
+  end
+end
+TXT
+      end
+
+      # writes a test_helper
+      def make_test_helper
+        write 'test/test_helper.r', <<-TXT
+# Test Helper
+$:.unshift File.dirname(__FILE__) + '/../'
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+require 'minitest/autorun'
+require 'rack/test'
+require 'minitest/reporters'
+require 'minitest/hooks'
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
+
+# Default TestCase with some helpers.
+# The same stuff we use for Camping itself.
+class TestCase < MiniTest::Test
+  include Rack::Test::Methods
+  include Minitest::Hooks
+
+  def self.inherited(mod)
+    mod.app = Object.const_get(mod.to_s[/\w+/])
+    super
+  end
+
+  class << self
+    attr_accessor :app
+  end
+
+  def setup
+    super
+    Camping.make_camp
+  end
+
+  def body() last_response.body end
+  def app()  self.class.app     end
+
+  def response_body() last_response.to_a end
+
+  def assert_reverse
+    begin
+      yield
+    rescue Exception
+    else
+      assert false, "Block didn't fail"
+    end
   end
+
+  def assert_body(str, message="")
+    case str
+    when Regexp
+      assert_match(str, last_response.body.strip, message)
+    else
+      assert_equal(str.to_s, last_response.body.strip, message)
+    end
+  end
+
+  def assert_status(code, message="")
+    assert_equal(code, last_response.status, message)
+  end
+
+  def test_silly; end
 end
+
 TXT
       end
 
@@ -255,6 +344,7 @@ group :test do
   gem 'minitest', '~> 5.0'
   gem 'minitest-reporters'
   gem 'rack-test'
+  gem 'minitest-hooks'
 end
 
 GEM
@@ -268,6 +358,8 @@ Camping is really fun and I hope you enjoy it.
 
 Start camping by running: `camping` in the root directory.
 
+To start Camping in development mode run: `camping -e development
+
 READ
       end
 
@@ -341,48 +433,55 @@ RUBY
   end
 
   class Commands
+    class << self
 
-    # A helper method to spit out Routes for an application
-    def self.routes(theApp = Camping, silent = false)
-      routes = Camping::CommandsHelpers::RoutesParser.parse theApp
-      routes.display unless silent == true
-      return routes
-    end
+      # A helper method to spit out Routes for an application
+      def routes(theApp = Camping, silent = false)
+        routes = Camping::CommandsHelpers::RoutesParser.parse theApp
+        routes.display unless silent == true
+        return routes
+      end
 
-    def self.new_cmd(app_name=:Camp)
-      app_name = :Camp if app_name == nil
-      app_name = app_name.to_sym if app_name.class == String
+      def new_cmd(app_name=:Camp)
+
+        # Normalize the app_name
+        Camping::CommandsHelpers.app_name_from_input(app_name) => {app_name:, snake_name:, camel_name:}
+
+        # make a directory then move there.
+        # _original_dir = Dir.pwd
+        Dir.mkdir("#{snake_name}") unless Dir.exist?("#{snake_name}")
+        Dir.chdir("#{snake_name}")
+
+        # generate a new camping app in a directory named after it:
+        Generators::make_camp_file(camel_name)
+        Generators::make_gitignore()
+        Generators::make_rakefile()
+        Generators::make_ruby_version()
+        Generators::make_configkdl()
+        Generators::make_gemfile()
+        Generators::make_readme()
+        Generators::make_public_folder()
+        Generators::make_test_folder()
+        Generators::make_test_helper()
+
+        # optionally add omnibus support
+          # add src/ folder
+          # add lib/ folder
+          # add views/ folder
+
+        # optionally add a local database too, through guidebook
+          # add db/ folder
+          # add db/migrate folder
+          # add db/config.kdl
+          # append migrations stuff to Rakefile.
+          `ls`
+      end
 
-      snake_app_name = Camping::CommandsHelpers.to_snake_case(app_name).capitalize
-
-      # make a directory then move there.
-      # _original_dir = Dir.pwd
-      Dir.mkdir("#{snake_app_name}") unless Dir.exist?("#{snake_app_name}")
-      Dir.chdir("#{snake_app_name}")
-
-      # generate a new camping app in a directory named after it:
-      Generators::make_camp_file(app_name)
-      Generators::make_gitignore()
-      Generators::make_rakefile()
-      Generators::make_ruby_version()
-      Generators::make_configkdl()
-      Generators::make_gemfile()
-      Generators::make_readme()
-      Generators::make_public_folder()
-      Generators::make_test_folder()
-
-      # optionally add omnibus support
-        # add src/ folder
-        # add lib/ folder
-        # add views/ folder
-
-      # optionally add a local database too, through guidebook
-        # add db/ folder
-        # add db/migrate folder
-        # add db/config.kdl
-        # append migrations stuff to Rakefile.
-        `ls`
-    end
+      # TODO: Create this generator
+      # generates the apps folder from apps found in camp.rb or config.ru
+      # def generate_apps_folder
+      # end
 
+    end
   end
 end

data/lib/camping/gear/filters.rb

@@ -1,48 +1,48 @@
 # This gear is originally from filtering_camping gem by judofyr, and techarc.
 module Gear
-	module Filters
-		module ClassMethods
-			def filters
-				@_filters ||= {:before => [], :after => []}
-			end
+  module Filters
+    module ClassMethods
+      def filters
+        @_filters ||= {:before => [], :after => []}
+      end
 
-			def before(actions, &blk)
-				actions = [actions] unless actions.is_a?(Array)
-				actions.each do |action|
-					filters[:before] << [action, blk]
-				end
-			end
+      def before(actions, &blk)
+        actions = [actions] unless actions.is_a?(Array)
+        actions.each do |action|
+          filters[:before] << [action, blk]
+        end
+      end
 
-			def after(actions, &blk)
-				actions = [actions] unless actions.is_a?(Array)
-				actions.each do |action|
-					filters[:after] << [action, blk]
-				end
-			end
-		end
+      def after(actions, &blk)
+        actions = [actions] unless actions.is_a?(Array)
+        actions.each do |action|
+          filters[:after] << [action, blk]
+        end
+      end
+    end
 
-		def self.included(mod)
-			mod.extend(ClassMethods)
-		end
+    def self.included(mod)
+      mod.extend(ClassMethods)
+    end
 
-		def self.setup(app, *a, &block) end
+    def self.setup(app, *a, &block) end
 
-		def run_filters(type)
-			o = self.class.to_s.split("::")
-			filters = Object.const_get(o.first).filters
-			filters[type].each do |filter|
-				if (filter[0].is_a?(Symbol) && (filter[0] == o.last.to_sym || filter[0] == :all)) ||
-				 	(filter[0].is_a?(String) && /^#{filter[0]}\/?$/ =~ @env.REQUEST_URI)
-				 	self.instance_eval(&filter[1])
-				end
-			end
-		end
+    def run_filters(type)
+      o = self.class.to_s.split("::")
+      filters = Object.const_get(o.first).filters
+      filters[type].each do |filter|
+        if (filter[0].is_a?(Symbol) && (filter[0] == o.last.to_sym || filter[0] == :all)) ||
+           (filter[0].is_a?(String) && /^#{filter[0]}\/?$/ =~ @env.REQUEST_URI)
+           self.instance_eval(&filter[1])
+        end
+      end
+    end
 
-		def service(*a)
-			run_filters(:before)
-			super(*a)
-			run_filters(:after)
-			self
-		end
-	end
+    def service(*a)
+      run_filters(:before)
+      super(*a)
+      run_filters(:after)
+      self
+    end
+  end
 end

data/lib/camping/gear/kuddly.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# lib/camping/config
 # load and parse settings.
 
 begin

data/lib/camping/gear/nancy.rb

@@ -15,7 +15,6 @@ module Gear
 
 		class << self
 
-
 			# normalizes the routes provided to the controller, then returns some variables
 			# used in make_camping_route
 			def normalize_routes(routes)

data/lib/camping/{reloader.rb → loader.rb}

@@ -1,3 +1,6 @@
+require 'zeitwerk'
+require 'listen'
+
 module Camping
   # == The Camping Reloader
   #
@@ -31,18 +34,39 @@ module Camping
   # Blog and Wiki, but they will update themselves if yourapp.rb changes.
   #
   # You can also give Reloader more than one script.
-  class Reloader
+  class Loader
     attr_reader :file
+    Loaders = []
 
-    def initialize(file, &blk)
+    def initialize(file=nil, &blk)
       @file = file
       @mtime = Time.at(0)
       @requires = []
       @apps = {}
       @callback = blk
-
+      @root = Dir.pwd
+      @file = @root + '/camp.rb' if @file == nil
+      @zeit = Zeitwerk::Loader.new
+      Loaders << @zeit
+
+      # setup Zeit for this reloader
+      setup_zeit(@zeit)
+
+      # setup recursive listener on the apps and lib directories from the source script.
+      @listener = Listen.to("#{@root}/apps", "#{@root}/lib", "#{@root}") do |modified, added, removed|
+        @mtime = Time.now
+        reload!
+      end
+      start
     end
 
+    # pass through methods to the Listener.
+    # for testing purposes.
+    def processing_events?;@listener.processing? end
+    def stop;@listener.stop end
+    def pause;@listener.pause end
+    def start;@listener.start end
+
     def name
       @name ||= begin
         base = @file.dup
@@ -52,29 +76,29 @@ module Camping
       end
     end
 
-    # Loads the apps available in this script.  Use <tt>apps</tt> to get
-    # the loaded apps.
-    def load_apps(old_apps)
+    # remove_constants called inside this.
+    def load_everything()
       all_requires = $LOADED_FEATURES.dup
       all_apps = Camping::Apps.dup
 
       load_file
+      reload_directory("#{@root}/apps")
+      reload_directory("#{@root}/lib")
+      Camping.make_camp
     ensure
       @requires = []
-      dirs = []
       new_apps = Camping::Apps - all_apps
 
       @apps = new_apps.inject({}) do |hash, app|
         if file = app.options[:__FILE__]
           full = File.expand_path(file)
           @requires << [file, full]
-          dirs << full.sub(/\.[^.]+$/, '')
         end
 
         key = app.name.to_sym
         hash[key] = app
 
-        if !old_apps.include?(key)
+        apps.each do |app|
           @callback.call(app) if @callback
           app.create if app.respond_to?(:create)
         end
@@ -84,12 +108,13 @@ module Camping
 
       ($LOADED_FEATURES - all_requires).each do |req|
         full = full_path(req)
-        @requires << [req, full] if dirs.any? { |x| full.index(x) == 0 }
+        @requires << [req, full] # if dirs.any? { |x| full.index(x) == 0 }
       end
 
       @mtime = mtime
 
       self
+
     end
 
     # load_file
@@ -102,13 +127,15 @@ module Camping
       else
         load(@file)
       end
+      @requires << [@file, File.expand_path(@file)]
     end
 
-    # Removes all the apps defined in this script.
-    def remove_apps
-      @requires.each do |(path, full)|
-        $LOADED_FEATURES.delete(path)
-      end
+    # removes all constants recursively included using this script as a root.
+    # so everything in /apps, and /lib in relation from this script.
+    def remove_constants
+    	@requires.each do |(path, full)|
+     		$LOADED_FEATURES.delete(path)
+     	end
 
       @apps.each do |name, app|
         Camping::Apps.delete(app)
@@ -116,6 +143,7 @@ module Camping
       end.dup
     ensure
       @apps.clear
+      @requires.clear
     end
 
     # Reloads the file if needed.  No harm is done by calling this multiple
@@ -125,8 +153,10 @@ module Camping
       reload!
     end
 
+    # Force a reload.
     def reload!
-      load_apps(remove_apps)
+      remove_constants
+      load_everything
     end
 
     # Checks if both scripts watches the same file.
@@ -144,6 +174,46 @@ module Camping
 
     private
 
+    # sets up Zeit autoloading for the script locations.
+    def setup_zeit(loader)
+      loader.push_dir("#{@root}/apps") if can_add_directory "#{@root}/apps"
+      loader.push_dir("#{@root}/lib") if can_add_directory "#{@root}/lib"
+	    loader.enable_reloading if ENV['environment'] == 'development'
+	    loader.setup
+    end
+
+    # verifies that we can add a directory to the loader.
+    # used for testing to prevent multiple loaders from watching the same directory.
+    def can_add_directory(directory)
+      if Dir.exist?("#{@root}/apps")
+        Loaders.each do |loader|
+          return false if loader.dirs.include? directory
+        end
+        true
+      else
+        false
+      end
+    end
+
+    # Splits the descendent files and folders found in a given directory for eager loading and recursion.
+    def folders_and_files_in(directory)
+      directory = directory + "/*" # unless directory
+      [Dir.glob(directory).select {|f| !File.directory? f },
+      Dir.glob(directory).select {|f| File.directory? f }]
+    end
+
+    # Reloads a directory recursively. loading more shallow files before deeper files.
+    def reload_directory(directory)
+      files, folders = folders_and_files_in(directory)
+      files.each {|file|
+        @requires << [file, File.expand_path(file)]
+        load file
+      }
+      folders.each {|folder|
+        reload_directory folder
+      }
+    end
+
     def mtime
       @requires.map do |(path, full)|
         File.mtime(full)

data/lib/camping/loads.rb

@@ -8,8 +8,8 @@ require 'bundler/setup'
 
 # internal dependencies
 require 'camping/tools'
+require 'camping/campguide'
 require 'camping/gear/filters'
 require 'camping/gear/nancy'
 require 'camping/gear/inspection'
 require 'camping/gear/kuddly'
-

data/lib/camping/server.rb

@@ -3,7 +3,7 @@ require 'erb'
 require 'rack'
 require 'rackup'
 require 'camping/version'
-require 'camping/reloader'
+require 'camping/loader'
 require 'camping/commands'
 
 # == The Camping Server (for development)
@@ -128,9 +128,10 @@ module Camping
         exit
       end
 
+      @reloader.reload!
+      r = @reloader
+
       if options[:routes] == true
-        @reloader.reload!
-        r = @reloader
         eval("self", TOPLEVEL_BINDING).meta_def(:reload!) { r.reload!; nil }
         ARGV.clear
         Camping::Commands.routes
@@ -139,16 +140,11 @@ module Camping
 
       if options[:server] == "console"
         puts "** Starting console"
-        @reloader.reload!
-        r = @reloader
         eval("self", TOPLEVEL_BINDING).meta_def(:reload!) { r.reload!; nil }
         ARGV.clear
         IRB.start
         exit
       else
-        @reloader.reload!
-        r = @reloader
-        Camping.make_camp
         name = server.name[/\w+$/]
         puts "** Starting #{name} on #{options[:Host]}:#{options[:Port]}"
         super
@@ -215,7 +211,6 @@ module Camping
     def call(env)
       if ENV['environment'] == 'development'
         @reloader.reload
-        Camping.make_camp
       end
 
       # our switch statement iterates through possible app outcomes, no apps

data/lib/camping/session.rb

@@ -1,5 +1,5 @@
 require 'rack/session'
-class InsecureSecret < Exception #:nodoc: all
+class InsecureSecretError < Exception #:nodoc: all
 end
 module Camping
   # == Getting Started
@@ -31,7 +31,7 @@ module Camping
     def self.included(app)
       key    = "#{app}.state".downcase
       secret = app.options[:secret] || ['camping-secret',__FILE__, File.mtime('Rakefile')].join(":")*2
-      raise InsecureSecret, "You're Session Secret is too short. Minimum length is 64." if secret.length < 64
+      raise InsecureSecretError, "Your Session Secret is too short. Minimum length is 64." if secret.length < 64
       app.use Rack::Session::Cookie, :key => key, :secrets => secret
     end
   end