Class: Brief::Briefcase

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

Defined Under Namespace

Classes: Initializer

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DSL

#action, #define, #extend, #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(false).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 



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/brief/briefcase.rb', line 256

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

Class Method Details

.create_new_briefcase(options = {}) ⇒ Object 



267
268
269
 
# File 'lib/brief/briefcase.rb', line 267

def self.create_new_briefcase(options={})
  Brief::Briefcase::Initializer.new(options).run
end

Instance Method Details

#app_config_path ⇒ Object 



153
154
155
 
# File 'lib/brief/briefcase.rb', line 153

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

#app_models ⇒ Object 



165
166
167
 
# File 'lib/brief/briefcase.rb', line 165

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

#app_models_folder ⇒ Object 



157
158
159
 
# File 'lib/brief/briefcase.rb', line 157

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

#app_namespace ⇒ Object 



161
162
163
 
# File 'lib/brief/briefcase.rb', line 161

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

#app_path ⇒ Object 



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

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

#as_default(params = {}) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/brief/briefcase.rb', line 51

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

  base = {
    views: Brief.views.keys,
    key: briefcase.folder_name.to_s.parameterize,
    name: briefcase.folder_name.to_s.titlecase,
    settings: settings,
    cache_key: briefcase.cache_key
  }

  if params[:include_data] || params[:data]
    base[:data] = data.as_json
  end

  if params[:include_schema] || params[:schema]
    base[:schema] = schema_map
  end

  if params[:include_models] || params[:models]
    model_settings = {
      docs_path: docs_path
    }

    %w(urls content rendered attachments).each do |opt|
      model_settings[opt.to_sym] = !!(params[opt.to_sym] || params["include_#{opt}".to_sym])
    end

    all = all_models.compact

    base[:models] = all.map {|m| m.as_json(model_settings) }
  end

  base
end

#as_full_export(options = {}) ⇒ Object 



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

def as_full_export(options={})
  options.reverse_merge!(content: true, rendered: true, models: true, schema: true)
  as_default(options)
end

#assets_path ⇒ Object 



207
208
209
 
# File 'lib/brief/briefcase.rb', line 207

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

#assets_trail ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/brief/briefcase.rb', line 211

def assets_trail
  @assets_trail ||= Hike::Trail.new(assets_path).tap do |trail|
    trail.append_extensions '.svg', '.png', '.pdf', '.jpg', '.gif', '.mov'
    assets_path.children.select(&:directory?).each {|dir| trail.prepend_path(assets_path); trail.append_path(assets_path.join(dir)) }
  end
end

#cache_key ⇒ Object 



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

def cache_key
  "#{slug}:#{repository.cache_key}"
end

#config(&block) ⇒ Object 



112
113
114
115
116
 
# File 'lib/brief/briefcase.rb', line 112

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

#data ⇒ Object 



104
105
106
 
# File 'lib/brief/briefcase.rb', line 104

def data
  @data ||= data!
end

#data! ⇒ Object 



108
109
110
 
# File 'lib/brief/briefcase.rb', line 108

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

#data_path ⇒ Object 



229
230
231
 
# File 'lib/brief/briefcase.rb', line 229

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

#data_trail ⇒ Object 



233
234
235
236
237
238
 
# File 'lib/brief/briefcase.rb', line 233

def data_trail
  @docs_trail ||= Hike::Trail.new(data_path).tap do |trail|
    trail.append_extensions '.yaml', '.js', '.json', '.xls', '.xlsx', '.csv', '.txt'
    trail.append_path(data_path)
  end
end

#docs_path ⇒ Object 



225
226
227
 
# File 'lib/brief/briefcase.rb', line 225

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

#docs_trail ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/brief/briefcase.rb', line 218

def docs_trail
  @docs_trail ||= Hike::Trail.new(docs_path).tap do |trail|
    trail.append_extensions '.md', '.html.md', '.markdown'
    docs_path.children.select(&:directory?).each {|dir| trail.prepend_path(docs_path); trail.append_path(docs_path.join(dir)) }
  end
end

#find_asset(needle) ⇒ Object 



202
203
204
205
 
# File 'lib/brief/briefcase.rb', line 202

def find_asset(needle)
  found = assets_trail.find(needle)
  found && Pathname(found)
end

#folder_name ⇒ Object 



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

def folder_name
  root.basename
end

#generic_model_class_for(document) ⇒ Object 



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

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.



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/brief/briefcase.rb', line 128

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

  run(config_path) if config_path.exist?
end

#load_model_definitions ⇒ Object 



178
179
180
181
182
183
184
185
 
# File 'lib/brief/briefcase.rb', line 178

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



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

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 



169
170
171
172
 
# File 'lib/brief/briefcase.rb', line 169

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 



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/brief/briefcase.rb', line 240

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

  if value.to_s.match(/\./)
    Pathname(Brief.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 



252
253
254
 
# File 'lib/brief/briefcase.rb', line 252

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

#root ⇒ Object 



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

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

#run(code_or_file) ⇒ Object 



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

def run(code_or_file)
  code = code_or_file.is_a?(Pathname) ? code_or_file.read : code
  instance_eval(code) rescue nil
end

#schema_map(include_all = false) ⇒ Object 



98
99
100
101
102
 
# File 'lib/brief/briefcase.rb', line 98

def schema_map(include_all=false)
  list = include_all ? Brief::Model.classes : model_classes
  list.map(&:to_schema)
    .reduce({}.to_mash) {|m, k| m[k[:type_alias]] = k; m }
end

#server(options = {}) ⇒ Object 



118
119
120
 
# File 'lib/brief/briefcase.rb', line 118

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

#settings ⇒ Object 



40
41
42
 
# File 'lib/brief/briefcase.rb', line 40

def settings
  @settings ||= settings!
end

#settings! ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/brief/briefcase.rb', line 44

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

#slug ⇒ Object 



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

def slug
  options.fetch(:slug) { root.basename.to_s.parameterize }
end

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



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

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

  run(app_config_path) if app_path.try(&:exist?)
end

#uses_app? ⇒ Boolean

Returns:

  • (Boolean) 


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

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