Module: Bones::Plugins::BonesPlugin

Extended by:
BonesPlugin
Includes:
Helpers
Included in:
BonesPlugin
Defined in:
lib/bones/plugins/bones_plugin.rb

Defined Under Namespace

Modules: Syntax

Constant Summary

Constants included from Helpers

Helpers::DEV_NULL, Helpers::GEM, Helpers::HAVE, Helpers::HAVE_SVN, Helpers::RCOV, Helpers::RDOC, Helpers::SUDO

Instance Method Summary collapse

Methods included from Helpers

#find_file, #have?, #paragraphs_of, #quiet, #remove_desc_for_task

Instance Method Details

#define_tasks ⇒ Object 



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
 
# File 'lib/bones/plugins/bones_plugin.rb', line 182

def define_tasks
  namespace :bones do
    desc 'Show the current Mr Bones configuration'
    task :debug do |t|
      atr = if t.application.top_level_tasks.length == 2
        t.application.top_level_tasks.pop
      end

      ::Bones.help.show(atr, :descriptions => false, :values => true)
    end

    desc 'Show descriptions for the various Mr Bones configuration options'
    task :help do |t|
      atr = if t.application.top_level_tasks.length == 2
        t.application.top_level_tasks.pop
      end

      ::Bones.help.show(atr, :descriptions => true, :values => true)
    end

    desc 'Show the available Mr Bones configuration options'
    task :options do |t|
      atr = if t.application.top_level_tasks.length == 2
        t.application.top_level_tasks.pop
      end

      ::Bones.help.show(atr, :descriptions => false, :values => false)
    end
  end
end

#initialize_bones_plugin ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/bones/plugins/bones_plugin.rb', line 12

def initialize_bones_plugin
  config = ::Bones.config {
    # ==== Project Defaults
    name  nil, :desc => <<-__
      The project name that will be used for packaging and distributing
      your Ruby code as a gem.
    __

    summary  nil, :desc => <<-__
      A short summary of your project. This summary is required in the
      gemspec, and it is used by the rubygem framework when searching
      for gems. If a summary is not given, then the first sentence from
      the project's README description is used as the summary.
    __

    description  nil, :desc => <<-__
      A longer description of your project. The description is used in
      the gemspec, but it is not required to build a gem. If a
      description is not given then the first paragraph from the
      project's README description is used as the description.
    __

    changes  nil, :desc => <<-__
      The list of notable changes in your project since the last release.
      The changes are automatically filled in by reading the list of
      changes from the project's History file. Only the changes for the
      most current release are included.
    __

    license  nil, :desc => <<-__
      This should just be the name of your license. The full text of the
      license should be in a LICENSE file at the top-level of your gem when
      you build it. The simplest way is to specify the standard SPDX ID
      https://spdx.org/licenses/ for the license.
    __

    authors  nil, :desc => <<-__
      This can be a single author (as a string) or an array of authors
      if more than one person is working on the project.
    __

    email  nil, :desc => <<-__
      An email address so others can contact you with questions, bug
      reports, compliments, large quantities of cash, etc.
    __

    url  "\000", :desc => <<-__
      The canonical URL for your project. This should be a location
      where others can go to find out more information about the project
      such as links to source code, bug trackers, wikis, generated
      documentation, etc. A good recommendation would be to point
      to your gem on rubygems.org.
    __

    version  nil, :desc => <<-__
      Version number to use when creating the gem. This can be set either
      in the Rakefile or on the command line by setting the VERSION flag to
      the desired value.
      |
      |  rake gem VERSION=0.4.2
      |
      The VERSION flag must be explicitly set on the command line when
      releasing a gem. This is just a safety measure to prevent premature
      gem release.
    __

    release_name  ENV['RELEASE'], :desc => <<-__
      And optional release name to be associated with your gem. This is used
      only when creating a release announcement.
    __

    exclude  %w(tmp$ bak$ ~$ CVS \.svn/ ^\.git/ ^pkg/), :desc => <<-__
      A list of regular expression patterns that will be used to exclude
      certain files from the gem packaging process. Each pattern is given
      as a string, and they are all combined using the regular expression
      or "|" operator.
    __

    # ==== System Defaults
    ruby_opts  %w(-w), :desc => <<-__
      Default options to pass to the Ruby interpreter when executing tests
      and specs. The default is to enable all warnings. Since this is an
      array, the current options can be cleared and new options can be added
      using the standard array operations
      |
      |  ruby_opts.clear
      |  ruby_opts << '-Ilib' << '-rubygems'
      |
    __

    libs  Array.new, :desc => <<-__
      This is an array of directories to automatically include in the
      LOAD_PATH of your project. These directories are use for tests and
      specs, and the gem system sets the "require_paths" for the gem from
      these directories. If no libs are given, then the "lib" and "ext"
      directories are automatically added if they are present in your
      project.
    __

    history_file  nil, :desc => <<-__
      The name of your project's History file. The default is 'History.txt'
      but you are free to change it to whatever you choose.
    __

    readme_file  nil, :desc => <<-__
      The name of your project's README file. The default is 'README.md'
      but you are free to change it to whatever you choose. Since GitHub
      understand various markup languages, you can change the README
      file to support your markup language of choice.
    __

    ignore_file  nil, :desc => <<-__
      Mr Bones does not use a manifest to determine which fiels should be
      included in your project. All files are included unless they appear
      in the ignore file or in the "exclude" configruation option. The
      ignore file defaults to '.bnsignore'; however, if you are using git
      as your version control system you can just as easily set the ignore
      file to your '.gitignore' file.
    __

    colorize  true, :desc => <<-__
      When set to true, various output from Mr Bones will be colorized
      using terminal ANSI codes. Set to false if your terminal does not
      support colors.
    __

    use_sudo  false, :desc => <<-__
      When set to true gem commands will be run using sudo. A convenience
      method is provided to enable sudo for gem commands
      |
      |  enable_sudo
      |
      This is equivalent to 'use_sudo true', but it reads a little nicer.
    __
  }

  config.history_file = Proc.new { find_file(*%w[History.txt History HISTORY.txt HISTORY]) }
  config.ignore_file = Proc.new { find_file(*%w[.gitignore .bnsignore]) }
  config.readme_file = Proc.new { find_file(*%w[
      README.txt README.rdoc README.md README
      Readme.txt Readme.rdoc Readme.md Readme
  ]) }
end

#post_load ⇒ Object 



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
 
# File 'lib/bones/plugins/bones_plugin.rb', line 156

def post_load
  config = ::Bones.config

  config.exclude << "^#{Regexp.escape(config.ignore_file)}$"
  config.changes     ||= paragraphs_of(config.history_file, 0..1).join("\n\n")

  first_readme_para = paragraphs_of(config.readme_file, 0..0).first.to_s
  config.summary ||= first_readme_para[%r/^[^.]*\.?/]
  config.description ||= paragraphs_of(config.readme_file, 'description').join("\n\n")
  if config.description.empty?
      config.description = first_readme_para
  end

  config.version ||= (ENV['VERSION'] ? ENV['VERSION'].dup : nil)
  if test(?f, 'version.txt') and !config.version
    config.version = File.read('version.txt').strip
  end
  config.version ||= '0.0.0'

  if config.libs.empty?
    %w(lib ext).each { |dir| config.libs << dir if test ?d, dir }
  end

  ::Bones::Helpers::SUDO.replace('') unless config.use_sudo
end