Class: Rubysmith::Configuration::Model
- Inherits:
-
Struct
- Object
- Struct
- Rubysmith::Configuration::Model
- Defined in:
- lib/rubysmith/configuration/model.rb
Overview
Defines the common configuration content for use throughout the gem.
Instance Attribute Summary collapse
-
#author_email ⇒ Object
Returns the value of attribute author_email.
-
#author_family_name ⇒ Object
Returns the value of attribute author_family_name.
-
#author_given_name ⇒ Object
Returns the value of attribute author_given_name.
-
#author_url ⇒ Object
Returns the value of attribute author_url.
-
#build_amazing_print ⇒ Object
Returns the value of attribute build_amazing_print.
-
#build_caliber ⇒ Object
Returns the value of attribute build_caliber.
-
#build_circle_ci ⇒ Object
Returns the value of attribute build_circle_ci.
-
#build_citation ⇒ Object
Returns the value of attribute build_citation.
-
#build_cli ⇒ Object
Returns the value of attribute build_cli.
-
#build_community ⇒ Object
Returns the value of attribute build_community.
-
#build_conduct ⇒ Object
Returns the value of attribute build_conduct.
-
#build_console ⇒ Object
Returns the value of attribute build_console.
-
#build_contributions ⇒ Object
Returns the value of attribute build_contributions.
-
#build_debug ⇒ Object
Returns the value of attribute build_debug.
-
#build_funding ⇒ Object
Returns the value of attribute build_funding.
-
#build_git ⇒ Object
Returns the value of attribute build_git.
-
#build_git_hub ⇒ Object
Returns the value of attribute build_git_hub.
-
#build_git_hub_ci ⇒ Object
Returns the value of attribute build_git_hub_ci.
-
#build_git_lint ⇒ Object
Returns the value of attribute build_git_lint.
-
#build_guard ⇒ Object
Returns the value of attribute build_guard.
-
#build_license ⇒ Object
Returns the value of attribute build_license.
-
#build_maximum ⇒ Object
Returns the value of attribute build_maximum.
-
#build_minimum ⇒ Object
Returns the value of attribute build_minimum.
-
#build_rake ⇒ Object
Returns the value of attribute build_rake.
-
#build_readme ⇒ Object
Returns the value of attribute build_readme.
-
#build_reek ⇒ Object
Returns the value of attribute build_reek.
-
#build_refinements ⇒ Object
Returns the value of attribute build_refinements.
-
#build_rspec ⇒ Object
Returns the value of attribute build_rspec.
-
#build_security ⇒ Object
Returns the value of attribute build_security.
-
#build_setup ⇒ Object
Returns the value of attribute build_setup.
-
#build_simple_cov ⇒ Object
Returns the value of attribute build_simple_cov.
-
#build_versions ⇒ Object
Returns the value of attribute build_versions.
-
#build_yard ⇒ Object
Returns the value of attribute build_yard.
-
#build_zeitwerk ⇒ Object
Returns the value of attribute build_zeitwerk.
-
#citation_affiliation ⇒ Object
Returns the value of attribute citation_affiliation.
-
#citation_message ⇒ Object
Returns the value of attribute citation_message.
-
#citation_orcid ⇒ Object
Returns the value of attribute citation_orcid.
-
#documentation_format ⇒ Object
Returns the value of attribute documentation_format.
-
#extensions_milestoner_documentation_format ⇒ Object
Returns the value of attribute extensions_milestoner_documentation_format.
-
#extensions_milestoner_prefixes ⇒ Object
Returns the value of attribute extensions_milestoner_prefixes.
-
#extensions_pragmater_comments ⇒ Object
Returns the value of attribute extensions_pragmater_comments.
-
#extensions_pragmater_patterns ⇒ Object
Returns the value of attribute extensions_pragmater_patterns.
-
#extensions_tocer_label ⇒ Object
Returns the value of attribute extensions_tocer_label.
-
#extensions_tocer_patterns ⇒ Object
Returns the value of attribute extensions_tocer_patterns.
-
#git_hub_user ⇒ Object
Returns the value of attribute git_hub_user.
-
#license_label ⇒ Object
Returns the value of attribute license_label.
-
#license_name ⇒ Object
Returns the value of attribute license_name.
-
#license_version ⇒ Object
Returns the value of attribute license_version.
-
#now ⇒ Object
Returns the value of attribute now.
-
#project_name ⇒ Object
Returns the value of attribute project_name.
-
#project_url_community ⇒ Object
Returns the value of attribute project_url_community.
-
#project_url_conduct ⇒ Object
Returns the value of attribute project_url_conduct.
-
#project_url_contributions ⇒ Object
Returns the value of attribute project_url_contributions.
-
#project_url_download ⇒ Object
Returns the value of attribute project_url_download.
-
#project_url_funding ⇒ Object
Returns the value of attribute project_url_funding.
-
#project_url_home ⇒ Object
Returns the value of attribute project_url_home.
-
#project_url_issues ⇒ Object
Returns the value of attribute project_url_issues.
-
#project_url_license ⇒ Object
Returns the value of attribute project_url_license.
-
#project_url_security ⇒ Object
Returns the value of attribute project_url_security.
-
#project_url_source ⇒ Object
Returns the value of attribute project_url_source.
-
#project_url_versions ⇒ Object
Returns the value of attribute project_url_versions.
-
#project_version ⇒ Object
Returns the value of attribute project_version.
-
#target_root ⇒ Object
Returns the value of attribute target_root.
-
#template_path ⇒ Object
Returns the value of attribute template_path.
-
#template_roots ⇒ Object
Returns the value of attribute template_roots.
Instance Method Summary collapse
- #ascii_doc? ⇒ Boolean
- #author_name ⇒ Object
- #computed_project_url_community ⇒ Object
- #computed_project_url_conduct ⇒ Object
- #computed_project_url_contributions ⇒ Object
- #computed_project_url_download ⇒ Object
- #computed_project_url_funding ⇒ Object
- #computed_project_url_home ⇒ Object
- #computed_project_url_issues ⇒ Object
- #computed_project_url_license ⇒ Object
- #computed_project_url_security ⇒ Object
- #computed_project_url_source ⇒ Object
- #computed_project_url_versions ⇒ Object
-
#initialize ⇒ Model
constructor
A new instance of Model.
- #license_label_version ⇒ Object
- #markdown? ⇒ Boolean
- #maximize ⇒ Object
- #minimize ⇒ Object
- #pathway ⇒ Object
- #project_class ⇒ Object
- #project_label ⇒ Object
- #project_levels ⇒ Object
- #project_namespaced_class ⇒ Object
- #project_path ⇒ Object
- #project_root ⇒ Object
- #template_root ⇒ Object
Constructor Details
#initialize ⇒ Model
Returns a new instance of Model.
82 83 84 85 |
# File 'lib/rubysmith/configuration/model.rb', line 82 def initialize(**) super freeze end |
Instance Attribute Details
#author_email ⇒ Object
Returns the value of attribute author_email
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def @author_email end |
#author_family_name ⇒ Object
Returns the value of attribute author_family_name
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def @author_family_name end |
#author_given_name ⇒ Object
Returns the value of attribute author_given_name
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def @author_given_name end |
#author_url ⇒ Object
Returns the value of attribute author_url
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def @author_url end |
#build_amazing_print ⇒ Object
Returns the value of attribute build_amazing_print
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_amazing_print @build_amazing_print end |
#build_caliber ⇒ Object
Returns the value of attribute build_caliber
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_caliber @build_caliber end |
#build_circle_ci ⇒ Object
Returns the value of attribute build_circle_ci
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_circle_ci @build_circle_ci end |
#build_citation ⇒ Object
Returns the value of attribute build_citation
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_citation @build_citation end |
#build_cli ⇒ Object
Returns the value of attribute build_cli
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_cli @build_cli end |
#build_community ⇒ Object
Returns the value of attribute build_community
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_community @build_community end |
#build_conduct ⇒ Object
Returns the value of attribute build_conduct
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_conduct @build_conduct end |
#build_console ⇒ Object
Returns the value of attribute build_console
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_console @build_console end |
#build_contributions ⇒ Object
Returns the value of attribute build_contributions
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_contributions @build_contributions end |
#build_debug ⇒ Object
Returns the value of attribute build_debug
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_debug @build_debug end |
#build_funding ⇒ Object
Returns the value of attribute build_funding
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_funding @build_funding end |
#build_git ⇒ Object
Returns the value of attribute build_git
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_git @build_git end |
#build_git_hub ⇒ Object
Returns the value of attribute build_git_hub
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_git_hub @build_git_hub end |
#build_git_hub_ci ⇒ Object
Returns the value of attribute build_git_hub_ci
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_git_hub_ci @build_git_hub_ci end |
#build_git_lint ⇒ Object
Returns the value of attribute build_git_lint
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_git_lint @build_git_lint end |
#build_guard ⇒ Object
Returns the value of attribute build_guard
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_guard @build_guard end |
#build_license ⇒ Object
Returns the value of attribute build_license
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_license @build_license end |
#build_maximum ⇒ Object
Returns the value of attribute build_maximum
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_maximum @build_maximum end |
#build_minimum ⇒ Object
Returns the value of attribute build_minimum
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_minimum @build_minimum end |
#build_rake ⇒ Object
Returns the value of attribute build_rake
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_rake @build_rake end |
#build_readme ⇒ Object
Returns the value of attribute build_readme
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_readme @build_readme end |
#build_reek ⇒ Object
Returns the value of attribute build_reek
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_reek @build_reek end |
#build_refinements ⇒ Object
Returns the value of attribute build_refinements
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_refinements @build_refinements end |
#build_rspec ⇒ Object
Returns the value of attribute build_rspec
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_rspec @build_rspec end |
#build_security ⇒ Object
Returns the value of attribute build_security
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_security @build_security end |
#build_setup ⇒ Object
Returns the value of attribute build_setup
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_setup @build_setup end |
#build_simple_cov ⇒ Object
Returns the value of attribute build_simple_cov
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_simple_cov @build_simple_cov end |
#build_versions ⇒ Object
Returns the value of attribute build_versions
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_versions @build_versions end |
#build_yard ⇒ Object
Returns the value of attribute build_yard
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_yard @build_yard end |
#build_zeitwerk ⇒ Object
Returns the value of attribute build_zeitwerk
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def build_zeitwerk @build_zeitwerk end |
#citation_affiliation ⇒ Object
Returns the value of attribute citation_affiliation
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def citation_affiliation @citation_affiliation end |
#citation_message ⇒ Object
Returns the value of attribute citation_message
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def @citation_message end |
#citation_orcid ⇒ Object
Returns the value of attribute citation_orcid
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def citation_orcid @citation_orcid end |
#documentation_format ⇒ Object
Returns the value of attribute documentation_format
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def documentation_format @documentation_format end |
#extensions_milestoner_documentation_format ⇒ Object
Returns the value of attribute extensions_milestoner_documentation_format
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_milestoner_documentation_format @extensions_milestoner_documentation_format end |
#extensions_milestoner_prefixes ⇒ Object
Returns the value of attribute extensions_milestoner_prefixes
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_milestoner_prefixes @extensions_milestoner_prefixes end |
#extensions_pragmater_comments ⇒ Object
Returns the value of attribute extensions_pragmater_comments
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_pragmater_comments @extensions_pragmater_comments end |
#extensions_pragmater_patterns ⇒ Object
Returns the value of attribute extensions_pragmater_patterns
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_pragmater_patterns @extensions_pragmater_patterns end |
#extensions_tocer_label ⇒ Object
Returns the value of attribute extensions_tocer_label
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_tocer_label @extensions_tocer_label end |
#extensions_tocer_patterns ⇒ Object
Returns the value of attribute extensions_tocer_patterns
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def extensions_tocer_patterns @extensions_tocer_patterns end |
#git_hub_user ⇒ Object
Returns the value of attribute git_hub_user
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def git_hub_user @git_hub_user end |
#license_label ⇒ Object
Returns the value of attribute license_label
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def license_label @license_label end |
#license_name ⇒ Object
Returns the value of attribute license_name
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def license_name @license_name end |
#license_version ⇒ Object
Returns the value of attribute license_version
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def license_version @license_version end |
#now ⇒ Object
Returns the value of attribute now
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def now @now end |
#project_name ⇒ Object
Returns the value of attribute project_name
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_name @project_name end |
#project_url_community ⇒ Object
Returns the value of attribute project_url_community
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_community @project_url_community end |
#project_url_conduct ⇒ Object
Returns the value of attribute project_url_conduct
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_conduct @project_url_conduct end |
#project_url_contributions ⇒ Object
Returns the value of attribute project_url_contributions
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_contributions @project_url_contributions end |
#project_url_download ⇒ Object
Returns the value of attribute project_url_download
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_download @project_url_download end |
#project_url_funding ⇒ Object
Returns the value of attribute project_url_funding
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_funding @project_url_funding end |
#project_url_home ⇒ Object
Returns the value of attribute project_url_home
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_home @project_url_home end |
#project_url_issues ⇒ Object
Returns the value of attribute project_url_issues
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_issues @project_url_issues end |
#project_url_license ⇒ Object
Returns the value of attribute project_url_license
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_license @project_url_license end |
#project_url_security ⇒ Object
Returns the value of attribute project_url_security
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_security @project_url_security end |
#project_url_source ⇒ Object
Returns the value of attribute project_url_source
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_source @project_url_source end |
#project_url_versions ⇒ Object
Returns the value of attribute project_url_versions
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_url_versions @project_url_versions end |
#project_version ⇒ Object
Returns the value of attribute project_version
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def project_version @project_version end |
#target_root ⇒ Object
Returns the value of attribute target_root
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def target_root @target_root end |
#template_path ⇒ Object
Returns the value of attribute template_path
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def template_path @template_path end |
#template_roots ⇒ Object
Returns the value of attribute template_roots
11 12 13 |
# File 'lib/rubysmith/configuration/model.rb', line 11 def template_roots @template_roots end |
Instance Method Details
#ascii_doc? ⇒ Boolean
129 |
# File 'lib/rubysmith/configuration/model.rb', line 129 def ascii_doc? = documentation_format == "adoc" |
#author_name ⇒ Object
91 |
# File 'lib/rubysmith/configuration/model.rb', line 91 def = [, ].compress.join(" ") |
#computed_project_url_community ⇒ Object
107 |
# File 'lib/rubysmith/configuration/model.rb', line 107 def computed_project_url_community = format_url(__method__) |
#computed_project_url_conduct ⇒ Object
109 |
# File 'lib/rubysmith/configuration/model.rb', line 109 def computed_project_url_conduct = format_url(__method__) |
#computed_project_url_contributions ⇒ Object
111 |
# File 'lib/rubysmith/configuration/model.rb', line 111 def computed_project_url_contributions = format_url(__method__) |
#computed_project_url_download ⇒ Object
113 |
# File 'lib/rubysmith/configuration/model.rb', line 113 def computed_project_url_download = format_url(__method__) |
#computed_project_url_funding ⇒ Object
115 |
# File 'lib/rubysmith/configuration/model.rb', line 115 def computed_project_url_funding = format_url(__method__) |
#computed_project_url_home ⇒ Object
117 |
# File 'lib/rubysmith/configuration/model.rb', line 117 def computed_project_url_home = format_url(__method__) |
#computed_project_url_issues ⇒ Object
119 |
# File 'lib/rubysmith/configuration/model.rb', line 119 def computed_project_url_issues = format_url(__method__) |
#computed_project_url_license ⇒ Object
121 |
# File 'lib/rubysmith/configuration/model.rb', line 121 def computed_project_url_license = format_url(__method__) |
#computed_project_url_security ⇒ Object
123 |
# File 'lib/rubysmith/configuration/model.rb', line 123 def computed_project_url_security = format_url(__method__) |
#computed_project_url_source ⇒ Object
125 |
# File 'lib/rubysmith/configuration/model.rb', line 125 def computed_project_url_source = format_url(__method__) |
#computed_project_url_versions ⇒ Object
127 |
# File 'lib/rubysmith/configuration/model.rb', line 127 def computed_project_url_versions = format_url(__method__) |
#license_label_version ⇒ Object
93 |
# File 'lib/rubysmith/configuration/model.rb', line 93 def license_label_version = [license_label, license_version].compress.join("-") |
#markdown? ⇒ Boolean
131 |
# File 'lib/rubysmith/configuration/model.rb', line 131 def markdown? = documentation_format == "md" |
#maximize ⇒ Object
87 |
# File 'lib/rubysmith/configuration/model.rb', line 87 def maximize = true |
#minimize ⇒ Object
89 |
# File 'lib/rubysmith/configuration/model.rb', line 89 def minimize = false |
#pathway ⇒ Object
133 134 135 |
# File 'lib/rubysmith/configuration/model.rb', line 133 def pathway Pathway[start_root: template_root, start_path: template_path, end_root: target_root] end |
#project_class ⇒ Object
95 |
# File 'lib/rubysmith/configuration/model.rb', line 95 def project_class = project_namespaced_class.split("::").last |
#project_label ⇒ Object
99 |
# File 'lib/rubysmith/configuration/model.rb', line 99 def project_label = project_name.titleize |
#project_levels ⇒ Object
101 |
# File 'lib/rubysmith/configuration/model.rb', line 101 def project_levels = project_namespaced_class.split("::").size - 1 |
#project_namespaced_class ⇒ Object
97 |
# File 'lib/rubysmith/configuration/model.rb', line 97 def project_namespaced_class = project_name.camelcase |
#project_path ⇒ Object
103 |
# File 'lib/rubysmith/configuration/model.rb', line 103 def project_path = project_name.snakecase |
#project_root ⇒ Object
105 |
# File 'lib/rubysmith/configuration/model.rb', line 105 def project_root = target_root.join(project_name) |
#template_root ⇒ Object
137 138 139 140 |
# File 'lib/rubysmith/configuration/model.rb', line 137 def template_root Array(template_roots).map(&:expand_path) .find { |path| path.join(String(template_path)).exist? } end |