Class: Brief::Briefcase

Inherits:
Object
  • Object
show all
Includes:
DSL
Defined in:
lib/brief/briefcase.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DSL

#action, #define, #view

Constructor Details

#initialize(options = {}) ⇒ Briefcase

Returns a new instance of Briefcase.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/brief/briefcase.rb', line 8

def initialize(options = {})
  @options = options.to_mash

  load_configuration
  use(:app, options[:app]) if options[:app]

  load_model_definitions

  if Brief.case.nil?
    Brief.case = self
  end

  Brief.cases[root.basename.to_s] ||= self
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args, &block) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/brief/briefcase.rb', line 202

def method_missing(meth, *args, &block)
  if Brief.views.key?(meth.to_sym)
    block = Brief.views[meth.to_sym]
    block.call(self, args.extract_options!)
  elsif repository.respond_to?(meth)
    repository.send(meth, *args, &block)
  else
    super
  end
end

Instance Attribute Details

#model_definitions ⇒ Object (readonly)

Returns the value of attribute model_definitions.



5
6
7
 
# File 'lib/brief/briefcase.rb', line 5

def model_definitions
  @model_definitions
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/brief/briefcase.rb', line 5

def options
  @options
end

Instance Method Details

#app_config_path ⇒ Object 



129
130
131
 
# File 'lib/brief/briefcase.rb', line 129

def app_config_path
  uses_app? && app_path.join("config.rb")
end

#app_models ⇒ Object 



141
142
143
 
# File 'lib/brief/briefcase.rb', line 141

def app_models
  app_namespace.constants.map {|c| app_namespace.const_get(c) }
end

#app_models_folder ⇒ Object 



133
134
135
 
# File 'lib/brief/briefcase.rb', line 133

def app_models_folder
  uses_app? && app_path.join("models")
end

#app_namespace ⇒ Object 



137
138
139
 
# File 'lib/brief/briefcase.rb', line 137

def app_namespace
  Brief::Apps.find_namespace(options[:app])
end

#app_path ⇒ Object 



125
126
127
 
# File 'lib/brief/briefcase.rb', line 125

def app_path
  uses_app? && Brief::Apps.path_for(options[:app]).to_pathname
end

#as_default(params = {}) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/brief/briefcase.rb', line 43

def as_default(params={})
  params.symbolize_keys!

  model_settings = {
    docs_path: docs_path
  }

  model_settings[:rendered] = !!(params.key?(:rendered))
  model_settings[:content] = !!(params.key?(:content))

  all = all_models.compact

  schema = all.map(&:class).uniq.compact
             .map(&:to_schema)
             .reduce({}) {|m, k| m[k[:type_alias]] = k; m }

  models = all.map {|m| m.as_json(model_settings) }

  {
    views: Brief.views.keys,
    key: briefcase.folder_name.to_s.parameterize,
    name: briefcase.folder_name.to_s.titlecase,
    schema: schema,
    models: models,
    settings: settings
  }
end

#as_full_export ⇒ Object 



71
72
73
 
# File 'lib/brief/briefcase.rb', line 71

def as_full_export
  as_default(content: true, rendered: true)
end

#config(&block) ⇒ Object 



91
92
93
94
95
 
# File 'lib/brief/briefcase.rb', line 91

def config(&block)
  Brief::Configuration.instance.tap do |cfg|
    cfg.instance_eval(&block) if block.respond_to?(:call)
  end
end

#data ⇒ Object 



83
84
85
 
# File 'lib/brief/briefcase.rb', line 83

def data
  @data ||= data!
end

#data! ⇒ Object 



87
88
89
 
# File 'lib/brief/briefcase.rb', line 87

def data!
  @data = Brief::Data::Wrapper.new(root: data_path)
end

#data_path ⇒ Object 



182
183
184
 
# File 'lib/brief/briefcase.rb', line 182

def data_path
  root.join options.fetch(:data_path) { config.data_path }
end

#docs_path ⇒ Object 



178
179
180
 
# File 'lib/brief/briefcase.rb', line 178

def docs_path
  root.join options.fetch(:docs_path) { config.docs_path }
end

#folder_name ⇒ Object 



101
102
103
 
# File 'lib/brief/briefcase.rb', line 101

def folder_name
  root.basename
end

#generic_model_class_for(document) ⇒ Object 



150
151
152
 
# File 'lib/brief/briefcase.rb', line 150

def generic_model_class_for(document)
  Brief::Model.for_type(document.document_type) || Brief::Model.for_folder_name(document.parent_folder_name)
end

#load_configuration ⇒ Object

Loads the configuration for this briefcase, either from the current working directory or the configured path for the configuration file.



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/brief/briefcase.rb', line 107

def load_configuration
  config_path = options.fetch(:config_path) do
    root.join('brief.rb')
  end

  if config_path.is_a?(String)
    config_path = root.join(config_path)
  end

  if config_path.exist?
    instance_eval(config_path.read) rescue nil
  end
end

#load_model_definitions ⇒ Object 



154
155
156
157
158
159
160
161
 
# File 'lib/brief/briefcase.rb', line 154

def load_model_definitions
  if uses_app?
    Brief.load_modules_from(app_path.join("models"))
  end

  Brief.load_modules_from(models_path) if models_path.exist?
  Brief::Model.finalize
end

#model(name_or_type) ⇒ Object

Returns a model name by its human readable description or its type alias



164
165
166
167
168
169
170
171
172
 
# File 'lib/brief/briefcase.rb', line 164

def model(name_or_type)
  table = Brief::Model.table

  table.fetch(name_or_type) do
    table.values.find do |k|
      k.name == name_or_type
    end
  end
end

#model_class_for(document) ⇒ Object 



145
146
147
148
 
# File 'lib/brief/briefcase.rb', line 145

def model_class_for(document)
  return generic_model_class_for(document) unless uses_app?
  app_models.find {|k| k.type_alias == document.document_type }
end

#models_path ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/brief/briefcase.rb', line 186

def models_path
  value = options.fetch(:models_path) { config.models_path }

  if value.to_s.match(/\./)
    Pathname(Dir.pwd).join(value)
  elsif value.to_s.match(/\//)
    Pathname(value)
  else
    root.join(value)
  end
end

#present(style = "default", params = {}) ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/brief/briefcase.rb', line 23

def present(style="default", params={})
  if respond_to?("as_#{style}")
    send("as_#{style}", params)
  elsif Brief.views.key?(style.to_sym)
    block = Brief.views[style.to_sym]
    block.call(self, params)
  end
end

#repository ⇒ Object 



198
199
200
 
# File 'lib/brief/briefcase.rb', line 198

def repository
  @repository ||= Brief::Repository.new(self, options)
end

#root ⇒ Object 



174
175
176
 
# File 'lib/brief/briefcase.rb', line 174

def root
  Pathname(options.fetch(:root) { Dir.pwd })
end

#server(options = {}) ⇒ Object 



97
98
99
 
# File 'lib/brief/briefcase.rb', line 97

def server(options={})
  @server ||= Brief::Server.new(self, options)
end

#settings ⇒ Object 



32
33
34
 
# File 'lib/brief/briefcase.rb', line 32

def settings
  @settings ||= settings!
end

#settings! ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/brief/briefcase.rb', line 36

def settings!
  if root.join("settings.yml").exist?
    y = YAML.load(root.join("settings.yml").read) rescue nil
    (y || {}).to_mash
  end
end

#use(module_type = :app, module_id) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/brief/briefcase.rb', line 75

def use(module_type=:app, module_id)
  options[:app] = module_id.to_s

  if app_path && app_path.exist?
    instance_eval(app_config_path.read)
  end
end

#uses_app? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/brief/briefcase.rb', line 121

def uses_app?
  options.key?(:app) && Brief::Apps.available?(options[:app].to_s)
end