Class: Albacore::Project

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/albacore/project.rb

Overview

a project encapsulates the properties from a xxproj file.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

#debug, #err, #error, #fatal, #info, #puts, #trace, #warn

Constructor Details

#initialize(proj_path) ⇒ Project

Returns a new instance of Project.

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
 
# File 'lib/albacore/project.rb', line 20

def initialize proj_path
  raise ArgumentError, 'project path does not exist' unless File.exists? proj_path.to_s
  proj_path = proj_path.to_s unless proj_path.is_a? String
  @proj_xml_node = Nokogiri.XML(open(proj_path))
  @proj_path_base, @proj_filename = File.split proj_path
  sanity_checks
end

Instance Attribute Details

#proj_filename ⇒ Object (readonly)

Returns the value of attribute proj_filename.



18
19
20
 
# File 'lib/albacore/project.rb', line 18

def proj_filename
  @proj_filename
end

#proj_path_base ⇒ Object (readonly)

Returns the value of attribute proj_path_base.



18
19
20
 
# File 'lib/albacore/project.rb', line 18

def proj_path_base
  @proj_path_base
end

#proj_xml_node ⇒ Object (readonly)

Returns the value of attribute proj_xml_node.



18
19
20
 
# File 'lib/albacore/project.rb', line 18

def proj_xml_node
  @proj_xml_node
end

Instance Method Details

#asmname ⇒ Object

get the assembly name specified in the project file



54
55
56
 
# File 'lib/albacore/project.rb', line 54

def asmname
  read_property 'AssemblyName'
end

#authors ⇒ Object

gets any authors from the project file



69
70
71
 
# File 'lib/albacore/project.rb', line 69

def authors
  read_property 'Authors'
end

#declared_packages ⇒ Object 



141
142
143
 
# File 'lib/albacore/project.rb', line 141

def declared_packages
  return nuget_packages || paket_packages || []
end

#declared_projects ⇒ Object 



145
146
147
148
149
150
151
152
153
 
# File 'lib/albacore/project.rb', line 145

def declared_projects
  @proj_xml_node.css("ProjectReference").collect do |proj_ref|
    debug do
      ref_name = proj_ref.css("Name").inner_text
      "found project reference: #{name} => #{ref_name} [albacore: project]"
    end
    Project.new(File.join(@proj_path_base, Albacore::Paths.normalise_slashes(proj_ref['Include'])))
  end
end

#description ⇒ Object 



73
74
75
 
# File 'lib/albacore/project.rb', line 73

def description
  read_property 'Description'
end

#fallback_output_path ⇒ Object

This is the output path if the project file doens’t have a configured ‘Configuration’ condition like all default project files have that come from Visual Studio/Xamarin Studio.



102
103
104
105
106
107
 
# File 'lib/albacore/project.rb', line 102

def fallback_output_path
  fallback = @proj_xml_node.css("Project PropertyGroup OutputPath").first
  condition = fallback.parent['Condition'] || 'No \'Condition\' specified'
  warn "chose an OutputPath in: '#{self}' for Configuration: <#{condition}> [albacore: project]"
  fallback.inner_text
end

#faulty_refs ⇒ Object 



121
122
123
 
# File 'lib/albacore/project.rb', line 121

def faulty_refs
  find_refs.to_a.keep_if{ |r| r.children.css("HintPath").empty? }
end

#find_packages ⇒ Object

Find all packages that have been declared and can be found in ./src/packages. This is mostly useful if you have that repository structure. returns enumerable Package



174
175
176
177
178
179
180
 
# File 'lib/albacore/project.rb', line 174

def find_packages
  declared_packages.collect do |package|
    guess = ::Albacore::PackageRepo.new(%w|./packages ./src/packages|).find_latest package.id
    debug "#{name}: guess: #{guess} [albacore: project]"
    guess
  end
end

#find_refs ⇒ Object

find the NodeList reference list



116
117
118
119
 
# File 'lib/albacore/project.rb', line 116

def find_refs
  # should always be there
  @proj_xml_node.css("Project Reference")
end

#guid ⇒ Object

Get the project GUID without ‘or ‘’ characters.



29
30
31
 
# File 'lib/albacore/project.rb', line 29

def guid
  guid_raw.gsub /[\{\}]/, ''
end

#guid_raw ⇒ Object

Get the project GUID as it is in the project file.



34
35
36
 
# File 'lib/albacore/project.rb', line 34

def guid_raw
  read_property 'ProjectGuid'
end

#has_faulty_refs? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/albacore/project.rb', line 125

def has_faulty_refs?
  faulty_refs.any?
end

#has_packages_config? ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/albacore/project.rb', line 129

def has_packages_config?
  File.exists? package_config
end

#has_paket_deps? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/albacore/project.rb', line 133

def has_paket_deps?
  File.exists? paket_deps
end

#has_paket_refs? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/albacore/project.rb', line 137

def has_paket_refs?
  File.exists? paket_refs
end

#id ⇒ Object

Get the project id specified in the project file. Defaults to #name.



39
40
41
 
# File 'lib/albacore/project.rb', line 39

def id
  (read_property 'Id') || name
end

#included_files ⇒ Object

returns a list of the files included in the project



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/albacore/project.rb', line 156

def included_files
  ['Compile','Content','EmbeddedResource','None'].map { |item_name|
    proj_xml_node.xpath("/x:Project/x:ItemGroup/x:#{item_name}",
      'x' => "http://schemas.microsoft.com/developer/msbuild/2003").collect { |f|
      debug "#{name}: #included_files looking at '#{f}' [albacore: project]"
      link = f.elements.select{ |el| el.name == 'Link' }.map { |el| el.content }.first
      OpenStruct.new(
        :item_name => item_name.downcase,
        :link      => link,
        :include   => f['Include']
      )
    }
  }.flatten
end

#license ⇒ Object

the license that the project has defined in the metadata in the xxproj file.



78
79
80
 
# File 'lib/albacore/project.rb', line 78

def license
  read_property 'License'
end

#name ⇒ Object Also known as: title

Get the project name specified in the project file. This is the same as the title of the nuspec and, if Id is not specified, also the id of the nuspec.



46
47
48
 
# File 'lib/albacore/project.rb', line 46

def name
  (read_property 'Name') || asmname
end

#namespace ⇒ Object

Get the root namespace of the project



59
60
61
 
# File 'lib/albacore/project.rb', line 59

def namespace
  read_property 'RootNamespace'
end

#output_dll(conf) ⇒ Object

Gets the relative location (to the project base path) of the dll that it will output



111
112
113
 
# File 'lib/albacore/project.rb', line 111

def output_dll conf
  Paths.join(output_path(conf) || fallback_output_path, "#{asmname}.dll")
end

#output_path(conf) ⇒ Object

gets the output path of the project given the configuration or raise an error otherwise



84
85
86
 
# File 'lib/albacore/project.rb', line 84

def output_path conf
  try_output_path conf || raise(ConfigurationNotFoundError, "could not find configuration '#{conf}'")
end

#package_config ⇒ Object

get the full path of ‘packages.config’



194
195
196
 
# File 'lib/albacore/project.rb', line 194

def package_config
  File.join @proj_path_base, 'packages.config'
end

#paket_deps ⇒ Object

Get the full path of ‘paket.dependencies’



199
200
201
 
# File 'lib/albacore/project.rb', line 199

def paket_deps
  File.join @proj_path_base, 'paket.dependencies'
end

#paket_refs ⇒ Object

Get the full path of ‘paket.references’



204
205
206
 
# File 'lib/albacore/project.rb', line 204

def paket_refs
  File.join @proj_path_base, 'paket.references'
end

#path ⇒ Object

get the path of the project file



183
184
185
 
# File 'lib/albacore/project.rb', line 183

def path
  File.join @proj_path_base, @proj_filename
end

#save(output = nil) ⇒ Object

save the xml



188
189
190
191
 
# File 'lib/albacore/project.rb', line 188

def save(output = nil)
  output = path unless output
  File.open(output, 'w') { |f| @proj_xml_node.write_xml_to f }
end

#to_s ⇒ Object

Gets the path of the project file



209
210
211
 
# File 'lib/albacore/project.rb', line 209

def to_s
  path
end

#try_output_path(conf) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/albacore/project.rb', line 88

def try_output_path conf
  default_platform = @proj_xml_node.css('Project PropertyGroup Platform').first.inner_text || 'AnyCPU'
  path = @proj_xml_node.css("Project PropertyGroup[Condition*='#{conf}|#{default_platform}'] OutputPath")
  # path = @proj_xml_node.xpath("//Project/PropertyGroup[matches(@Condition, '#{conf}')]/OutputPath")

  debug { "#{name}: output path node[#{conf}]: #{ (path.empty? ? 'empty' : path.inspect) } [albacore: project]" }

  return path.inner_text unless path.empty?
  nil
end

#version ⇒ Object

gets the version from the project file



64
65
66
 
# File 'lib/albacore/project.rb', line 64

def version
  read_property 'Version'
end