Anshorei
/
squib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

cleanup

dev
Andy Meneely 6 years ago
parent
02bf443abf
commit
750cb40267
4 changed files with 130 additions and 128 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 209
      lib/squib/args/arg_loader.rb
  2. 43
      lib/squib/dsl/background.rb
  3. 2
      lib/squib/errors_warnings/warn_unexpected_params.rb
  4. 4
      spec/spec_helper.rb

209
lib/squib/args/arg_loader.rb
Unescape View File

@ -2,125 +2,122 @@ require_relative '../constants'
require_relative '../conf' require_relative '../conf'
require 'ostruct' require 'ostruct'
module Squib # Intended to be used a a mix-in,
# @api private # For example use see Box as an example
module Args module Squib::Args::ArgLoader
# wrapper for compatibility
def extract!(args, deck)
load!(args, expand_by: deck.size, layout: deck.layout, dpi: deck.dpi)
end
# Intended to be used a a mix-in, # Main class invoked by the client (i.e. api/ methods)
# For example use see Box as an example def load!(args, expand_by: 1, layout: {}, dpi: 300)
module ArgLoader @dpi = dpi
args[:layout] = prep_layout_args(args[:layout], expand_by: expand_by)
expand_and_set_and_defaultify(args: args, by: expand_by, layout: layout)
validate
convert_units dpi: dpi
self
end
# Main class invoked by the client (i.e. api/ methods) def expand_and_set_and_defaultify(args: {}, by: 1, layout: {})
def load!(args, expand_by: 1, layout: {}, dpi: 300) attributes = self.class.parameters.keys
Squib.logger.debug { "ARG LOADER: load! for #{self.class}, args: #{args}" } attributes.each do |p|
@dpi = dpi args[p] = defaultify(p, args, layout)
args[:layout] = prep_layout_args(args[:layout], expand_by: expand_by) val = if expandable_singleton?(p, args[p])
expand_and_set_and_defaultify(args: args, by: expand_by, layout: layout) [args[p]] * by
validate else
convert_units dpi: dpi args[p] # not an expanding parameter
self end
end instance_variable_set "@#{p}", val
end
self.class.class_eval { attr_reader *(attributes) }
end
def expand_and_set_and_defaultify(args: {}, by: 1, layout: {}) # Must be:
attributes = self.class.parameters.keys # (a) an expanding parameter, and
attributes.each do |p| # (b) a singleton already (i.e. doesn't respond to :each)
args[p] = defaultify(p, args, layout) def expandable_singleton?(p, arg)
val = if expandable_singleton?(p, args[p]) self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each)
[args[p]] * by end
else
args[p] # not an expanding parameter
end
instance_variable_set "@#{p}", val
end
self.class.class_eval { attr_reader *(attributes) }
end
# Must be: # Incorporate defaults and layouts
# (a) an expanding parameter, and # (1) Use whatever is specified if it is
# (b) a singleton already (i.e. doesn't respond to :each) # (2) Go over all layout specifications (if any) and look them up
def expandable_singleton?(p, arg) # - Use layout when it's specified for that card
self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each) # - Use "default" if no layout was specified, or the layout itself did not specify
# Defaut can be overriden for a given dsl method (@dsl_method_defaults)
# (e.g stroke width is 0.0 for text, non-zero everywhere else)
#
def defaultify(p, args, layout)
return args[p] if args.key? p # arg was specified, no defaults used
defaults = self.class.parameters.merge(@dsl_method_defaults || {})
args[:layout].map do |layout_arg|
return defaults[p] if layout_arg.nil? # no layout specified, use default
unless layout.key? layout_arg.to_s # specified a layout, but it doesn't exist in layout. Oops!
Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
return defaults[p]
end end
if layout[layout_arg.to_s].key?(p.to_s)
# Incorporate defaults and layouts layout[layout_arg.to_s][p.to_s] # param specified in layout
# (1) Use whatever is specified if it is else
# (2) Go over all layout specifications (if any) and look them up defaults[p] # layout specified, but not this param
# - Use layout when it's specified for that card
# - Use "default" if no layout was specified, or the layout itself did not specify
# Defaut can be overriden for a given dsl method (@dsl_method_defaults)
# (e.g stroke width is 0.0 for text, non-zero everywhere else)
#
def defaultify(p, args, layout)
return args[p] if args.key? p # arg was specified, no defaults used
defaults = self.class.parameters.merge(@dsl_method_defaults || {})
args[:layout].map do |layout_arg|
return defaults[p] if layout_arg.nil? # no layout specified, use default
unless layout.key? layout_arg.to_s # specified a layout, but it doesn't exist in layout. Oops!
Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
return defaults[p]
end
if layout[layout_arg.to_s].key?(p.to_s)
layout[layout_arg.to_s][p.to_s] # param specified in layout
else
defaults[p] # layout specified, but not this param
end
end
end end
end
end
# Do singleton expansion on the layout argument as well # Do singleton expansion on the layout argument as well
# Treated differently since layout is not always specified # Treated differently since layout is not always specified
def prep_layout_args(layout_args, expand_by: 1) def prep_layout_args(layout_args, expand_by: 1)
unless layout_args.respond_to?(:each) unless layout_args.respond_to?(:each)
layout_args = [layout_args] * expand_by layout_args = [layout_args] * expand_by
end end
layout_args || [] layout_args || []
end end
# For each parameter/attribute foo we try to invoke a validate_foo # For each parameter/attribute foo we try to invoke a validate_foo
def validate def validate
self.class.parameters.each do |param, default| self.class.parameters.each do |param, default|
method = "validate_#{param}" method = "validate_#{param}"
if self.respond_to? method if self.respond_to? method
attribute = "@#{param}" attribute = "@#{param}"
val = instance_variable_get(attribute) val = instance_variable_get(attribute)
if val.respond_to? :each if val.respond_to? :each
new_val = val.map.with_index{ |v, i| send(method, v, i) } new_val = val.map.with_index{ |v, i| send(method, v, i) }
instance_variable_set(attribute, new_val) instance_variable_set(attribute, new_val)
else else
instance_variable_set(attribute, send(method, val)) instance_variable_set(attribute, send(method, val))
end
end
end end
end end
end
end
# Access an individual arg for a given card # Access an individual arg for a given card
# @return an OpenStruct that looks just like the mixed-in class # @return an OpenStruct that looks just like the mixed-in class
# @api private # @api private
def [](i) def [](i)
card_arg = OpenStruct.new card_arg = OpenStruct.new
self.class.expanding_parameters.each do |p| self.class.expanding_parameters.each do |p|
p_val = instance_variable_get("@#{p}") p_val = instance_variable_get("@#{p}")
card_arg[p] = p_val[i] card_arg[p] = p_val[i]
end end
card_arg card_arg
end end
# Convert units # Convert units
def convert_units(dpi: 300) def convert_units(dpi: 300)
self.class.params_with_units.each do |p| self.class.params_with_units.each do |p|
p_str = "@#{p}" p_str = "@#{p}"
p_val = instance_variable_get(p_str) p_val = instance_variable_get(p_str)
if p_val.respond_to? :each if p_val.respond_to? :each
arr = p_val.map { |x| UnitConversion.parse(x, dpi) } arr = p_val.map { |x| Squib::Args::UnitConversion.parse(x, dpi) }
instance_variable_set p_str, arr instance_variable_set p_str, arr
else else
instance_variable_set p_str, UnitConversion.parse(p_val, dpi) instance_variable_set p_str, Squib::Args::UnitConversion.parse(p_val, dpi)
end
end
self
end end
end end
self
end end
end end

43
lib/squib/dsl/background.rb
Unescape View File

@ -2,33 +2,34 @@ require_relative '../errors_warnings/warn_unexpected_params'
module Squib module Squib
class Deck class Deck
def background(opts = {}) # DSL method. See http://squib.readthedocs.io def background(opts = {})
BackgroundDSLMethod.new(self, __callee__).run(opts) DSL::Background.new(self, __callee__).run(opts)
end end
end end
class BackgroundDSLMethod module DSL
include WarnUnexpectedParams class Background
include WarnUnexpectedParams
attr_reader :dsl_method, :deck
attr_reader :dsl_method, :deck def initialize(deck, dsl_method)
@deck = deck
@dsl_method = dsl_method
end
def initialize(deck, dsl_method) def accepted_params
@deck = deck %i{
@dsl_method = dsl_method range
end color
}
def accepted_params end
%i{
range
color
}
end
def run(opts) def run(opts)
warn_if_unexpected opts warn_if_unexpected opts
range = Args::CardRange.new(opts[:range], deck_size: @deck.size) range = Args::CardRange.new(opts[:range], deck_size: deck.size)
draw = Args::Draw.new(@deck.custom_colors).load!(opts, expand_by: @deck.size, layout: @deck.layout, dpi: @deck.dpi) draw = Args::Draw.new(@deck.custom_colors).extract!(opts, deck)
range.each { |i| @deck.cards[i].background(draw.color[i]) } range.each { |i| @deck.cards[i].background(draw.color[i]) }
end
end end
end end
end end

2
lib/squib/errors_warnings/warn_unexpected_params.rb
Unescape View File

@ -6,7 +6,7 @@ module Squib::WarnUnexpectedParams
def warn_if_unexpected(opts, uplevel: 5) def warn_if_unexpected(opts, uplevel: 5)
unexpected = opts.keys - accepted_params unexpected = opts.keys - accepted_params
unexpected.each do |key| unexpected.each do |key|
warn "Unexpected parameter '#{key.to_s.yellow}:' to #{dsl_method.to_s.cyan}(), ignoring...", warn "Unexpected parameter '#{key.to_s.yellow}:' to #{dsl_method.to_s.cyan}(). Accepted parameters: #{accepted_params}",
uplevel: uplevel uplevel: uplevel
end end
end end

4
spec/spec_helper.rb
Unescape View File

@ -62,6 +62,10 @@ def project_template(file)
"#{File.expand_path(File.dirname(__FILE__))}/../lib/squib/project_template/#{file}" "#{File.expand_path(File.dirname(__FILE__))}/../lib/squib/project_template/#{file}"
end end
def doc(file)
"#{File.expand_path(File.dirname(__FILE__))}/../docs/#{file}"
end
def conf(file) def conf(file)
"#{File.expand_path(File.dirname(__FILE__))}/data/conf/#{file}" "#{File.expand_path(File.dirname(__FILE__))}/data/conf/#{file}"
end end

Write Preview
Loading…
Cancel
Save