Module: CookbookCreator::Generator::TemplateHelper

Defined in:

lib/cookbook_creator/generator.rb

Class Method Summary

• .delegate_to_app_context(name) ⇒ Object

Instance Method Summary

• #license_description(comment = nil) ⇒ Object

  Prints the short description of the license, suitable for use in a preamble to a file.

• #year ⇒ Object

Class Method Details

.delegate_to_app_context(name) ⇒ Object

# File 'lib/cookbook_creator/generator.rb', line 100

def self.delegate_to_app_context(name)
  define_method(name) do
    CookbookCreator::Generator.context.public_send(name)
  end
end

Instance Method Details

#license_description(comment = nil) ⇒ Object

Prints the short description of the license, suitable for use in a preamble to a file. Optionally specify a comment to prepend to each line.

# File 'lib/cookbook_creator/generator.rb', line 112

def license_description(comment=nil)
  case license
  when 'all_rights'
    result = "Copyright (c) #{year} #{copyright_holder}, All Rights Reserved."
  when 'apache2'
    result = "Copyright \#{year} \#{copyright_holder}\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n"
  when 'mit'
    result = "The MIT License (MIT)\n\nCopyright (c) \#{year} \#{copyright_holder}\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
  when 'gplv2'
    result = "Copyright (C) \#{year}  \#{copyright_holder}\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 2 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along\nwith this program; if not, write to the Free Software Foundation, Inc.,\n51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n"
  when 'gplv3'
    result = "Copyright (C) \#{year}  \#{copyright_holder}\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n"
  end
  if comment
    # Ensure there's no trailing whitespace
    result.gsub(/^(.+)$/, "#{comment} \\1").gsub(/^$/, "#{comment}")
  else
    result
  end
end

#year ⇒ Object

# File 'lib/cookbook_creator/generator.rb', line 106

def year
  Time.now.year
end