flame 4.18.1 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fbe52ed5ac3bee05b2739396b58c83dce8f6969
-  data.tar.gz: b54f7a5c830967546d696a4fcccf93e22dcab9c5
+  metadata.gz: 7e3d7d2c5f0cd76e641b7b5cc3999eeff5bf5c11
+  data.tar.gz: aa3c3efc4fba9d10060a554592be063f3384a7d8
 SHA512:
-  metadata.gz: 2c384ad693932e066041d145885cace94ebe75a3eaa1830853df0bb6ddacbcb423f9f69c36d5c2bcca2297079ab636529f9aa6294c1389378a43444b16dd72c1
-  data.tar.gz: 4747eaf2eb6651776abf63ccd809e174ff747006be9289e1ff6aa564e55e4f7aa475ffbe7dee6d1b3b21fa382dbe69d787c452c183fceacbab7a48052472d1c9
+  metadata.gz: aeb8af2e6436404b2478a31ae95598f04a0677d13c3ea27b5ec0eb6bef859d3378cfecbbb8a19a1e79e2d37062b3bc58a05c0189bba75be09d93d40d21bb3940
+  data.tar.gz: ab7eb4d61a48c01cbf122d2a180ac8fdb8945c28d4a1024970c0ff68edd68fcdd92f5aec08bb5612143225dcda135578b798f3465c8f70f74270dad437603ceb

data/bin/flame

@@ -2,70 +2,15 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'fileutils'
-require 'gorilla-patch/inflections'
-require 'erb'
 
-## CLI Application
-class FlameCLI < Thor
-	desc 'new APP', 'Generate new application directory with sub-directories'
-	def new(app_name)
-		FlameApp.new app_name
-	end
-
-	## Class for Flame Application
-	class FlameApp
-		def initialize(app_name)
-			@app_name = app_name
-			New.build @app_name
-			puts 'Done!'
-			puts "\nMoving to '#{@app_name}' directory by:\n\ncd #{@app_name}\n\n"
-		end
-
-		## Module for new application
-		module New
-			module_function
-
-			using GorillaPatch::Inflections
-
-			def build(app_name)
-				@app_name = app_name
-				@module_name = @app_name.camelize
-				make_dir do
-					copy_template
-				end
-			end
-
-			def make_dir(&block)
-				puts "Creating '#{@app_name}' directory..."
-				FileUtils.mkdir @app_name
-				FileUtils.cd @app_name, &block
-			end
-
-			def copy_template
-				puts 'Copy template directories and files...'
-				FileUtils.cp_r File.join(__dir__, '..', 'template', '.'), '.'
-				clean_dirs
-				render_templates
-			end
-
-			def clean_dirs
-				puts 'Clean directories...'
-				FileUtils.rm Dir[File.join('**', '*', '.keep')]
-			end
+require_relative 'new'
 
-			def render_templates
-				puts 'Replace module names in template...'
-				Dir[File.join('**', '*.erb')].each do |file|
-					basename = File.basename(file, '.*')
-					puts "- #{basename}"
-					content = ERB.new(File.read(file)).result(binding)
-					File.write(File.join(File.dirname(file), basename), content)
-					FileUtils.rm file
-				end
-			end
-		end
+module FlameCLI
+	## CLI Application
+	class Flame < Thor
+		desc 'new ENTITY ...ARGS', 'create new entity'
+		subcommand 'new', New
 	end
 end
 
-FlameCLI.start(ARGV)
+FlameCLI::Flame.start(ARGV)

data/lib/flame.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'addressable'
 require 'rack'
 
 require_relative 'flame/application'

data/lib/flame/application.rb

@@ -19,12 +19,28 @@ module Flame
 				@cached_tilts ||= {}
 			end
 
+			## Require project directories, exclude executable files
+			## @param dirs [Array<String>] Array of directories names
+			## @example Regular require of project
+			##   Flame::Application.require_dirs(
+			##     %w[config lib models helpers mailers services controllers]
+			##	 )
+			def require_dirs(dirs)
+				caller_dir = File.dirname caller_file
+				dirs.each do |dir|
+					Dir[File.join(caller_dir, dir, '**', '*.rb')]
+						.reject { |file| File.executable?(file) }
+						.sort_by { |s| [File.basename(s)[0], s] }
+						.each { |file| require File.expand_path(file) }
+				end
+			end
+
 			## Generating application config when inherited
 			def inherited(app)
 				app.config = Config.new(
 					app,
 					default_config_dirs(
-						root_dir: File.dirname(caller[0].split(':')[0])
+						root_dir: File.dirname(caller_file)
 					).merge(
 						environment: ENV['RACK_ENV'] || 'development'
 					)
@@ -37,24 +53,75 @@ module Flame
 				@app.call env
 			end
 
+			## Build a path to the given controller and action
+			##
+			## @param ctrl [Flame::Controller] class of controller
+			## @param action [Symbol] method of controller
+			## @param args [Hash] parameters for method of controller
+			## @return [String] path for requested method, controller and parameters
+			## @example Path for `show(id)` method of `ArticlesController`
+			##   path_to ArticlesController, :show, id: 2 # => "/articles/show/2"
+			## @example Path for `new` method of `ArticlesController` with params
+			##   path_to ArticlesController, :new, params: { author_id: 1 }
+			##   # => "/articles/new?author_id=1"
+			def path_to(ctrl, action = :index, args = {})
+				path = router.path_of(ctrl, action)
+				raise Errors::RouteNotFoundError.new(ctrl, action) unless path
+				query = Rack::Utils.build_nested_query args.delete(:params)
+				query = nil if query&.empty?
+				path = path.assign_arguments(args)
+				path = '/' if path.empty?
+				Addressable::URI.new(path: path, query: query).to_s
+			end
+
 			private
 
+			## Get filename from caller of method
+			## @return [String] filename of caller
+			def caller_file
+				caller(2..2).first.split(':')[0]
+			end
+
+			using GorillaPatch::DeepMerge
+
 			## Mount controller in application class
-			## @param ctrl [Flame::Controller] the mounted controller class
+			## @param controller [Symbol] the snake-cased name of mounted controller
+			##   (without `Controller` or `::IndexController` for namespaces)
 			## @param path [String, nil] root path for the mounted controller
 			## @yield refine defaults pathes for a methods of the mounted controller
 			## @example Mount controller with defaults
-			##   mount ArticlesController
+			##   mount :articles # ArticlesController
 			## @example Mount controller with specific path
-			##   mount HomeController, '/welcome'
+			##   mount :home, '/welcome' # HomeController
 			## @example Mount controller with specific path of methods
-			##   mount HomeController do
+			##   mount :home do # HomeController
 			##     get '/bye', :goodbye
 			##     post '/greetings', :new
 			##     defaults
 			##   end
-			def mount(ctrl, path = nil, &block)
-				router.add_controller(ctrl, path, &block)
+			## @example Mount controller with nested controllers
+			##   mount :cabinet do # Cabinet::IndexController
+			##     mount :articles # Cabinet::ArticlesController
+			##   end
+			def mount(controller_name, path = nil, &block)
+				## Add routes from controller to glob array
+
+				routes_refine = Router::RoutesRefine.new(
+					router, namespace, controller_name, path, &block
+				)
+
+				router.routes.deep_merge! routes_refine.routes
+				router.reverse_routes.merge! routes_refine.reverse_routes
+			end
+
+			using GorillaPatch::Namespace
+
+			def namespace
+				namespace = self
+				while namespace.name.nil? && namespace.superclass != Flame::Application
+					namespace = superclass
+				end
+				namespace.deconstantize
 			end
 
 			## Initialize default for config directories
@@ -67,15 +134,6 @@ module Flame
 			end
 		end
 
-		## Framework configuration
-		def config
-			self.class.config
-		end
-
-		def router
-			self.class.router
-		end
-
 		def initialize(app = nil)
 			@app = app
 		end
@@ -83,7 +141,7 @@ module Flame
 		## Request recieving method
 		def call(env)
 			@app.call(env) if @app.respond_to? :call
-			Flame::Dispatcher.new(self, env).run!
+			Flame::Dispatcher.new(self.class, env).run!
 		end
 	end
 end

data/lib/flame/application/config.rb

@@ -4,11 +4,17 @@ module Flame
 	class Application
 		## Class for Flame::Application.config
 		class Config < Hash
+			## Create an instance of application config
+			## @param app [Flame::Application] application
+			## @param hash [Hash] config content
 			def initialize(app, hash = {})
 				@app = app
 				replace(hash)
 			end
 
+			## Get config value by key
+			## @param key [Symbol] config key
+			## @return [Object] config value
 			def [](key)
 				result = super(key)
 				if result.class <= Proc && result.parameters.empty?

data/lib/flame/controller.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'gorilla-patch/namespace'
+
+require_relative 'controller/path_to'
 require_relative 'render'
 
 module Flame
@@ -9,13 +12,34 @@ module Flame
 	class Controller
 		extend Forwardable
 
-		FORBIDDEN_ACTIONS = [].freeze
-
 		## Shortcut for not-inherited public methods: actions
+		## @return [Array<Symbol>] array of actions (public instance methods)
 		def self.actions
 			public_instance_methods(false)
 		end
 
+		## Re-define public instance methods (actions) from parent
+		## @param actions [Array<Symbol>] Actions for inheritance
+		## @param exclude [Array<Symbol>] Actions for excluding from inheritance
+		## @example Inherit all parent actions
+		##   class MyController < BaseController
+		##     inherit_actions
+		##   end
+		## @example Inherit certain parent actions
+		##   class MyController < BaseController
+		##     inherit_actions :index, :show
+		##   end
+		## @example Inherit all parent actions exclude certain
+		##   class MyController < BaseController
+		##     inherit_actions exclude: %i[edit update]
+		##   end
+		def self.inherit_actions(actions = superclass.actions, exclude: [])
+			(actions - exclude).each do |public_method|
+				um = superclass.public_instance_method(public_method)
+				define_method public_method, um
+			end
+		end
+
 		def_delegators(
 			:@dispatcher,
 			:config, :request, :params, :halt, :session, :response, :status, :body,
@@ -23,29 +47,12 @@ module Flame
 		)
 
 		## Initialize the controller for request execution
-		## @param dispatcher [Flame::Dispatcher] dispatcher object
+		## @param dispatcher [Flame::Dispatcher] host dispatcher
 		def initialize(dispatcher)
 			@dispatcher = dispatcher
 		end
 
-		## Helpers
-		def path_to(*args)
-			add_controller_class(args)
-			@dispatcher.path_to(*args)
-		end
-
-		## Build a URI to the given controller and action, or path
-		def url_to(*args, **options)
-			first_arg = args.first
-			path =
-				if first_arg.is_a?(String) || first_arg.is_a?(Flame::Path)
-					static_file = find_static(first_arg)
-					static_file.path(with_version: options[:version])
-				else
-					path_to(*args, **options)
-				end
-			"#{request.scheme}://#{request.host_with_port}#{path}"
-		end
+		include Flame::Controller::PathTo
 
 		## Redirect for response
 		## @overload redirect(path, status)
@@ -107,7 +114,7 @@ module Flame
 		## @param path [Symbol, nil] path to the template file
 		## @param options [Hash] options for the `Flame::Render` rendering
 		## @return [String] rendered template
-		def view(path = nil, options = {})
+		def view(path = nil, options = {}, &block)
 			cache = options.delete(:cache)
 			cache = config[:environment] == 'production' if cache.nil?
 			template = Flame::Render.new(
@@ -115,7 +122,7 @@ module Flame
 				(path || caller_locations(1, 1)[0].label.to_sym),
 				options
 			)
-			template.render(cache: cache)
+			template.render(cache: cache, &block)
 		end
 		alias render view
 
@@ -128,6 +135,8 @@ module Flame
 		end
 
 		## Default method for Internal Server Error, can be inherited
+		## @param _exception [Exception] exception from code executing
+		## @return [String] content of exception page
 		def server_error(_exception)
 			body default_body
 		end
@@ -150,17 +159,17 @@ module Flame
 		end
 
 		def extract_params_for(action)
-			# Take parameters from action method
+			## Take parameters from action method
 			parameters = method(action).parameters
-			# Fill variables with values from params
+			## Fill variables with values from params
 			req_values, opt_values = %i[req opt].map! do |type|
 				params.values_at(
 					*parameters.select { |key, _value| key == type }.map!(&:last)
 				)
 			end
-			# Remove nils from the end of optional values
+			## Remove nils from the end of optional values
 			opt_values.pop while opt_values.last.nil? && !opt_values.empty?
-			# Concat values
+			## Concat values
 			req_values + opt_values
 		end
 
@@ -181,55 +190,6 @@ module Flame
 				parts = [modules.last] if parts.empty?
 				Flame::Path.merge nil, parts.join('_')
 			end
-
-			## Re-define public instance method from parent
-			## @example Inherit controller with parent actions by method
-			##   class MyController < BaseController.with_actions
-			##   end
-			## @example Define actions from module in controller
-			##   class MyController < BaseController
-			##     include with_actions Module1
-			##     include with_actions Module2
-			##     ....
-			##   end
-			def with_actions(mod = nil)
-				return mod.extend(ModuleActions) if mod
-				@with_actions ||= Class.new(self) { extend ParentActions }
-			end
-		end
-
-		## Extension for modules whose public methods will be defined as actions
-		## via including
-		module ModuleActions
-			def included(ctrl)
-				public_instance_methods.each do |meth|
-					ctrl.send :define_method, meth, public_instance_method(meth)
-				end
-			end
-		end
-
-		## Module for public instance methods re-defining from superclass
-		## @example Inherit controller with parent actions without forbidden
-		## actions by `extend`
-		##   class MyController < BaseController
-		##     FORBIDDEN_ACTIONS = %[foo bar baz].freeze
-		##     extend Flame::Controller::ParentActions
-		##   end
-		module ParentActions
-			def inherited(ctrl)
-				ctrl.define_parent_actions
-			end
-
-			def self.extended(ctrl)
-				ctrl.define_parent_actions
-			end
-
-			def define_parent_actions
-				(superclass.actions - self::FORBIDDEN_ACTIONS).each do |public_method|
-					um = superclass.public_instance_method(public_method)
-					define_method public_method, um
-				end
-			end
 		end
 	end
 end

data/lib/flame/controller/path_to.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Flame
+	class Controller
+		## Module with methods for path or URL building
+		module PathTo
+			## Look documentation at {Flame::Dispatcher#path_to}
+			def path_to(*args)
+				add_controller_class(args)
+				@dispatcher.path_to(*args)
+			end
+
+			## Build a URI to the given controller and action, or path
+			def url_to(*args, **options)
+				first_arg = args.first
+				path =
+					if first_arg.is_a?(String) || first_arg.is_a?(Flame::Path)
+						find_static(first_arg).path(with_version: options[:version])
+					else
+						path_to(*args, **options)
+					end
+				Addressable::URI.new(
+					scheme: request.scheme, host: request.host_with_port, path: path
+				).to_s
+			end
+
+			using GorillaPatch::Namespace
+
+			## Path to previous page, or to index action, or to Index controller
+			## @return [String] path to previous page or to index
+			def path_to_back
+				back_path = request.referer
+				return back_path if back_path && back_path != request.url
+				return path_to :index if self.class.actions.include?(:index)
+				'/'
+			end
+		end
+	end
+end