Class: ChefConfig::PackageTask

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/chef-config/package_task.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root_path = nil, module_name = nil) {|_self| ... } ⇒ PackageTask

Returns a new instance of PackageTask.

Yields:

  • (_self)

Yield Parameters:



62
63
64
65
66
 
# File 'lib/chef-config/package_task.rb', line 62

def initialize(root_path=nil, module_name=nil)
  init(root_path, module_name)
  yield self if block_given?
  define unless root_path.nil? || module_name.nil?
end

Instance Attribute Details

#component_paths ⇒ Object

Paths to the roots of any components that also support ChefPackageTask. If relative paths are provided, they are rooted against root_path.



39
40
41
 
# File 'lib/chef-config/package_task.rb', line 39

def component_paths
  @component_paths
end

#generate_version_class ⇒ Object

Should the generated version.rb be in a class or module? Default is false (module).



35
36
37
 
# File 'lib/chef-config/package_task.rb', line 35

def generate_version_class
  @generate_version_class
end

#git_remote ⇒ Object

Name of git remote used to push tags during a release. Default is origin.



60
61
62
 
# File 'lib/chef-config/package_task.rb', line 60

def git_remote
  @git_remote
end

#module_name ⇒ Object

Name of the top-level module/library build built. This is used to define the top level module which contains VERSION and MODULE_ROOT.



32
33
34
 
# File 'lib/chef-config/package_task.rb', line 32

def module_name
  @module_name
end

#module_path ⇒ Object 



46
47
48
 
# File 'lib/chef-config/package_task.rb', line 46

def module_path
  @module_path || module_name.downcase
end

#package_dir ⇒ Object

Directory used to store package files and output that is generated. This has the same meaning (or lack thereof) as package_dir in rake/packagetask.



57
58
59
 
# File 'lib/chef-config/package_task.rb', line 57

def package_dir
  @package_dir
end

#root_path ⇒ Object

Full path to root of top-level repository. All other files (like VERSION or lib/<module_path>/version.rb are rooted at this path).



28
29
30
 
# File 'lib/chef-config/package_task.rb', line 28

def root_path
  @root_path
end

#version_file_path ⇒ Object

Path to a VERSION file with a single string that contains the package version. By default, this is root_path/VERSION



52
53
54
 
# File 'lib/chef-config/package_task.rb', line 52

def version_file_path
  @version_file_path
end

Instance Method Details

#class_or_module ⇒ Object 



95
96
97
 
# File 'lib/chef-config/package_task.rb', line 95

def class_or_module
  generate_version_class ? 'class' : 'module'
end

#component_full_paths ⇒ Object 



79
80
81
 
# File 'lib/chef-config/package_task.rb', line 79

def component_full_paths
  component_paths.map { |path| File.expand_path(path, root_path)}
end

#define ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/chef-config/package_task.rb', line 107

def define
  fail 'Need to provide package root and module name' if root_path.nil? || module_name.nil?

  desc 'Build Gems of component dependencies'
  task :package_components do
    component_full_paths.each do |component_path|
      Dir.chdir(component_path) do
        sh 'rake package'
      end
    end
  end

  task :package => :package_components

  desc 'Build and install component dependencies'
  task :install_components => :package_components do
    component_full_paths.each do |component_path|
      Dir.chdir(component_path) do
        sh 'rake install'
      end
    end
  end

  task :install => :install_components

  desc 'Clean up builds of component dependencies'
  task :clobber_component_packages do
    component_full_paths.each do |component_path|
      Dir.chdir(component_path) do
        sh 'rake clobber_package'
      end
    end
  end

  task :clobber_package => :clobber_component_packages

  desc 'Update the version number for component dependencies'
  task :update_components_versions do
    component_full_paths.each do |component_path|
      Dir.chdir(component_path) do
        sh 'rake version'
      end
    end
  end

  desc 'Regenerate lib/#{@module_path}/version.rb from VERSION file'
  task :version => :update_components_versions do
    contents = "# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.\n# License:: Apache License, Version 2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n#     http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n# NOTE: This file is generated by running `rake version` in the top level of\n# this repo. Do not edit this manually. Edit the VERSION file and run the rake\n# task instead.\n#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n\#{class_or_module} \#{module_name}\n  \#{module_name.upcase}_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))\n  VERSION = '\#{version}'\nend\n\n#\n# NOTE: the Chef::Version class is defined in version_class.rb\n#\n# NOTE: DO NOT Use the Chef::Version class on \#{module_name}::VERSIONs.  The\n#       Chef::Version class is for _cookbooks_ only, and cannot handle\n#       pre-release versions like \"10.14.0.rc.2\".  Please use Rubygem's\n#       Gem::Version class instead.\n#\n    VERSION_RB\n    IO.write(version_rb_path, contents)\n  end\n\n  Dir[File.expand_path(\"*gemspec\", root_path)].reverse.each do |gemspec_path|\n    gemspec = eval(IO.read(gemspec_path))\n    Gem::PackageTask.new(gemspec) do |task|\n      task.package_dir = full_package_dir\n    end\n  end\n\n  desc \"Build and install a \#{module_path} gem\"\n  task :install => [:package] do\n    with_clean_env do\n      full_module_path = File.join(full_package_dir, module_path)\n      sh %{gem install \#{full_module_path}-\#{version}.gem --no-rdoc --no-ri}\n    end\n  end\n\n  task :uninstall do\n    sh %{gem uninstall \#{module_path} -x -v \#{version} }\n  end\n\n  desc 'Build it, tag it and ship it'\n  task :ship => [:clobber_package, :gem] do\n    sh(\"git tag \#{version}\")\n    sh(\"git push \#{git_remote} --tags\")\n    Dir[File.expand_path('*.gem', full_package_dir)].reverse.each do |built_gem|\n      sh(\"gem push \#{built_gem}\")\n    end\n  end\nend\n"

#full_package_dir ⇒ Object 



91
92
93
 
# File 'lib/chef-config/package_task.rb', line 91

def full_package_dir
  File.expand_path(package_dir, root_path)
end

#init(root_path, module_name) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/chef-config/package_task.rb', line 68

def init(root_path, module_name)
  @root_path = root_path
  @module_name = module_name
  @component_paths = []
  @module_path = nil
  @version_file_path = 'VERSION'
  @package_dir = 'pkg'
  @git_remote = 'origin'
  @generate_version_class = false
end

#version ⇒ Object 



87
88
89
 
# File 'lib/chef-config/package_task.rb', line 87

def version
  IO.read(File.expand_path(version_file_path, root_path)).strip
end

#version_rb_path ⇒ Object 



83
84
85
 
# File 'lib/chef-config/package_task.rb', line 83

def version_rb_path
  File.expand_path("lib/#{module_path}/version.rb", root_path)
end

#with_clean_env(&block) ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/chef-config/package_task.rb', line 99

def with_clean_env(&block)
  if defined?(Bundler)
    Bundler.with_clean_env(&block)
  else
    block.call
  end
end