noe 1.5.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG.md +6 -0
- data/Gemfile +1 -2
- data/Gemfile.lock +3 -2
- data/lib/noe.rbc +393 -0
- data/lib/noe/commons.rbc +1012 -0
- data/lib/noe/config.rbc +1534 -0
- data/lib/noe/ext/array.rbc +330 -0
- data/lib/noe/ext/hash.rbc +1193 -0
- data/lib/noe/go.rbc +5618 -0
- data/lib/noe/help.rbc +473 -0
- data/lib/noe/install.rbc +1521 -0
- data/lib/noe/list.rbc +1692 -0
- data/lib/noe/loader.rb +1 -1
- data/lib/noe/loader.rbc +85 -0
- data/lib/noe/main.rbc +1323 -0
- data/lib/noe/prepare.rb +14 -7
- data/lib/noe/prepare.rbc +1622 -0
- data/lib/noe/show_spec.rbc +627 -0
- data/lib/noe/template.rbc +4256 -0
- data/lib/noe/version.rb +5 -5
- data/lib/noe/version.rbc +350 -0
- data/noe.gemspec +25 -25
- data/noe.noespec +3 -3
- data/spec/fixtures/test.noespec +19 -0
- data/spec/integration/go/go_spec.rbc +236 -0
- data/spec/integration/spaces_spec.rb +30 -0
- data/spec/integration/spaces_spec.rbc +996 -0
- data/spec/integration/spec_helper.rbc +143 -0
- data/spec/unit/config/new_spec.rbc +1590 -0
- data/spec/unit/config/templates_dir_spec.rbc +1398 -0
- data/spec/unit/ext/hash/methodize_spec.rbc +851 -0
- data/spec/unit/ext/hash/noe_merge_spec.rbc +1544 -0
- data/spec/unit/noe_spec.rbc +309 -0
- data/spec/unit/spec_helper.rbc +143 -0
- data/spec/unit/template/entry/infer_wlang_dialect_spec.rbc +1236 -0
- data/spec/unit/template/entry/relocate_spec.rbc +1584 -0
- data/spec/unit/template/entry/rename_one_spec.rbc +1114 -0
- data/tasks/debug_mail.rake +13 -13
- data/tasks/gem.rake +13 -13
- data/tasks/spec_test.rake +10 -10
- data/tasks/unit_test.rake +9 -10
- data/tasks/yard.rake +13 -13
- data/templates/ruby/CHANGELOG.md +5 -0
- data/templates/ruby/README.md +13 -13
- data/templates/ruby/noespec.yaml +48 -48
- data/templates/ruby/short.yaml +10 -10
- data/templates/ruby/src/Gemfile +1 -2
- data/templates/ruby/src/Manifest.txt +1 -1
- data/templates/ruby/src/README.md +0 -1
- data/templates/ruby/src/__lower__.gemspec +24 -24
- data/templates/ruby/src/lib/__lower__.rb +1 -1
- data/templates/ruby/src/lib/__lower__/loader.rb +1 -1
- data/templates/ruby/src/lib/__lower__/version.rb +4 -4
- data/templates/ruby/src/spec/test___lower__.rb +2 -2
- data/templates/ruby/src/tasks/debug_mail.rake +13 -13
- data/templates/ruby/src/tasks/gem.rake +13 -13
- data/templates/ruby/src/tasks/spec_test.rake +9 -9
- data/templates/ruby/src/tasks/unit_test.rake +9 -10
- data/templates/ruby/src/tasks/yard.rake +13 -13
- metadata +125 -75
data/tasks/debug_mail.rake
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# Installs a rake task for debuging the announcement mail.
|
2
2
|
#
|
3
3
|
# This file installs the 'rake debug_mail' that flushes an announcement mail
|
4
|
-
# for your library on the standard output. It is automatically generated
|
5
|
-
# by Noe from your .noespec file, and should therefore be configured there,
|
4
|
+
# for your library on the standard output. It is automatically generated
|
5
|
+
# by Noe from your .noespec file, and should therefore be configured there,
|
6
6
|
# under the variables/rake_tasks/debug_mail entry, as illustrated below:
|
7
7
|
#
|
8
8
|
# variables:
|
@@ -12,9 +12,9 @@
|
|
12
12
|
# nb_changelog_sections: 1
|
13
13
|
# ...
|
14
14
|
#
|
15
|
-
# If you have specific needs requiring manual intervention on this file,
|
15
|
+
# If you have specific needs requiring manual intervention on this file,
|
16
16
|
# don't forget to set safe-override to false in your noe specification:
|
17
|
-
#
|
17
|
+
#
|
18
18
|
# template-info:
|
19
19
|
# manifest:
|
20
20
|
# tasks/debug_mail.rake:
|
@@ -22,8 +22,8 @@
|
|
22
22
|
#
|
23
23
|
# The mail template used can be found in debug_mail.txt. That file may be
|
24
24
|
# changed to tune the mail you want to send. If you do so, don't forget to
|
25
|
-
# add a manifest entry in your .noespec file to avoid overriding you
|
26
|
-
# changes. The mail template uses wlang, with parentheses for block
|
25
|
+
# add a manifest entry in your .noespec file to avoid overriding you
|
26
|
+
# changes. The mail template uses wlang, with parentheses for block
|
27
27
|
# delimiters.
|
28
28
|
#
|
29
29
|
# template-info:
|
@@ -34,20 +34,20 @@
|
|
34
34
|
begin
|
35
35
|
require 'wlang'
|
36
36
|
require 'yaml'
|
37
|
-
|
37
|
+
|
38
38
|
desc "Debug the release announcement mail"
|
39
|
-
task :debug_mail do
|
39
|
+
task :debug_mail do
|
40
40
|
# Check that a .noespec file exists
|
41
41
|
noespec_file = File.expand_path('../../noe.noespec', __FILE__)
|
42
42
|
unless File.exists?(noespec_file)
|
43
43
|
raise "Unable to find .noespec project file, sorry."
|
44
44
|
end
|
45
|
-
|
45
|
+
|
46
46
|
# Load it as well as variables and options
|
47
47
|
noespec = YAML::load(File.read(noespec_file))
|
48
48
|
vars = noespec['variables'] || {}
|
49
49
|
|
50
|
-
# Changes are taken from CHANGELOG
|
50
|
+
# Changes are taken from CHANGELOG
|
51
51
|
logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
|
52
52
|
unless logs.size == 1
|
53
53
|
abort "Unable to find a changelog file"
|
@@ -63,15 +63,15 @@ begin
|
|
63
63
|
changes << line
|
64
64
|
}
|
65
65
|
vars['changes'] = changes.join
|
66
|
-
|
66
|
+
|
67
67
|
# WLang template
|
68
68
|
template = File.expand_path('../debug_mail.txt', __FILE__)
|
69
|
-
|
69
|
+
|
70
70
|
# Let's go!
|
71
71
|
$stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
|
72
72
|
end
|
73
73
|
|
74
|
-
rescue LoadError
|
74
|
+
rescue LoadError
|
75
75
|
task :debug_mail do
|
76
76
|
abort "wlang is not available. Try 'gem install wlang'"
|
77
77
|
end
|
data/tasks/gem.rake
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# Installs rake tasks for gemming and packaging
|
2
2
|
#
|
3
|
-
# This file installs the 'rake package', 'rake gem' tasks and associates
|
4
|
-
# (clobber_package, repackage, ...). It is automatically generated by Noe
|
5
|
-
# from your .noespec file, and should therefore be configured there, under
|
3
|
+
# This file installs the 'rake package', 'rake gem' tasks and associates
|
4
|
+
# (clobber_package, repackage, ...). It is automatically generated by Noe
|
5
|
+
# from your .noespec file, and should therefore be configured there, under
|
6
6
|
# the variables/rake_tasks/gem entry, as illustrated below:
|
7
7
|
#
|
8
8
|
# variables:
|
@@ -15,9 +15,9 @@
|
|
15
15
|
# need_zip: false
|
16
16
|
# ...
|
17
17
|
#
|
18
|
-
# If you have specific needs requiring manual intervention on this file,
|
18
|
+
# If you have specific needs requiring manual intervention on this file,
|
19
19
|
# don't forget to set safe-override to false in your noe specification:
|
20
|
-
#
|
20
|
+
#
|
21
21
|
# template-info:
|
22
22
|
# manifest:
|
23
23
|
# tasks/gem.rake:
|
@@ -32,28 +32,28 @@ begin
|
|
32
32
|
|
33
33
|
# Version of the package
|
34
34
|
t.version = $gemspec.version
|
35
|
-
|
35
|
+
|
36
36
|
# Directory used to store the package files
|
37
37
|
t.package_dir = "pkg"
|
38
|
-
|
38
|
+
|
39
39
|
# True if a gzipped tar file (tgz) should be produced
|
40
40
|
t.need_tar = false
|
41
|
-
|
41
|
+
|
42
42
|
# True if a gzipped tar file (tar.gz) should be produced
|
43
43
|
t.need_tar_gz = false
|
44
|
-
|
44
|
+
|
45
45
|
# True if a bzip2'd tar file (tar.bz2) should be produced
|
46
46
|
t.need_tar_bz2 = false
|
47
|
-
|
47
|
+
|
48
48
|
# True if a zip file should be produced (default is false)
|
49
49
|
t.need_zip = false
|
50
|
-
|
50
|
+
|
51
51
|
# List of files to be included in the package.
|
52
52
|
t.package_files = $gemspec.files
|
53
|
-
|
53
|
+
|
54
54
|
# Tar command for gzipped or bzip2ed archives.
|
55
55
|
t.tar_command = "tar"
|
56
|
-
|
56
|
+
|
57
57
|
# Zip command for zipped archives.
|
58
58
|
t.zip_command = "zip"
|
59
59
|
|
data/tasks/spec_test.rake
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# Installs a rake task for for running examples written using rspec.
|
2
2
|
#
|
3
3
|
# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
|
4
|
-
# extends 'rake test' to run spec tests, if any. It is automatically generated
|
5
|
-
# by Noe from your .noespec file, and should therefore be configured there,
|
4
|
+
# extends 'rake test' to run spec tests, if any. It is automatically generated
|
5
|
+
# by Noe from your .noespec file, and should therefore be configured there,
|
6
6
|
# under the variables/rake_tasks/spec_test entry, as illustrated below:
|
7
7
|
#
|
8
8
|
# variables:
|
@@ -13,16 +13,16 @@
|
|
13
13
|
# rspec_opts: [--color, --backtrace]
|
14
14
|
# ...
|
15
15
|
#
|
16
|
-
# If you have specific needs requiring manual intervention on this file,
|
16
|
+
# If you have specific needs requiring manual intervention on this file,
|
17
17
|
# don't forget to set safe-override to false in your noe specification:
|
18
|
-
#
|
18
|
+
#
|
19
19
|
# template-info:
|
20
20
|
# manifest:
|
21
21
|
# tasks/spec_test.rake:
|
22
22
|
# safe-override: false
|
23
23
|
#
|
24
|
-
# This file has been written to conform to RSpec v2.4.0. More information about
|
25
|
-
# rspec and options of the rake task defined below can be found on
|
24
|
+
# This file has been written to conform to RSpec v2.4.0. More information about
|
25
|
+
# rspec and options of the rake task defined below can be found on
|
26
26
|
# http://relishapp.com/rspec
|
27
27
|
#
|
28
28
|
begin
|
@@ -30,17 +30,17 @@ begin
|
|
30
30
|
desc "Run RSpec code examples"
|
31
31
|
RSpec::Core::RakeTask.new(:spec_test) do |t|
|
32
32
|
# Glob pattern to match files.
|
33
|
-
t.pattern = "spec
|
33
|
+
t.pattern = "spec/**/*_spec.rb"
|
34
34
|
|
35
35
|
# By default, if there is a Gemfile, the generated command will include
|
36
|
-
# 'bundle exec'. Set this to true to ignore the presence of a Gemfile,
|
36
|
+
# 'bundle exec'. Set this to true to ignore the presence of a Gemfile,
|
37
37
|
# and not add 'bundle exec' to the command.
|
38
38
|
t.skip_bundler = false
|
39
39
|
|
40
40
|
# Name of Gemfile to use
|
41
41
|
t.gemfile = "Gemfile"
|
42
42
|
|
43
|
-
# Whether or not to fail Rake when an error occurs (typically when
|
43
|
+
# Whether or not to fail Rake when an error occurs (typically when
|
44
44
|
# examples fail).
|
45
45
|
t.fail_on_error = true
|
46
46
|
|
@@ -60,7 +60,7 @@ begin
|
|
60
60
|
# Command line options to pass to rcov. See 'rcov --help' about this
|
61
61
|
t.rcov_opts = []
|
62
62
|
|
63
|
-
# Command line options to pass to ruby. See 'ruby --help' about this
|
63
|
+
# Command line options to pass to ruby. See 'ruby --help' about this
|
64
64
|
t.ruby_opts = []
|
65
65
|
|
66
66
|
# Path to rspec
|
data/tasks/unit_test.rake
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# Installs a rake task for for running unit tests.
|
2
2
|
#
|
3
|
-
# This file installs the 'rake unit_test' and extends 'rake test' to run unit
|
4
|
-
# tests, if any. It is automatically generated by Noe from your .noespec file,
|
5
|
-
# and should therefore be configured there, under the variables/rake_tasks/unit_test
|
3
|
+
# This file installs the 'rake unit_test' and extends 'rake test' to run unit
|
4
|
+
# tests, if any. It is automatically generated by Noe from your .noespec file,
|
5
|
+
# and should therefore be configured there, under the variables/rake_tasks/unit_test
|
6
6
|
# entry, as illustrated below:
|
7
7
|
#
|
8
8
|
# variables:
|
@@ -13,15 +13,15 @@
|
|
13
13
|
# warning: false
|
14
14
|
# ...
|
15
15
|
#
|
16
|
-
# If you have specific needs requiring manual intervention on this file,
|
16
|
+
# If you have specific needs requiring manual intervention on this file,
|
17
17
|
# don't forget to set safe-override to false in your noe specification:
|
18
|
-
#
|
18
|
+
#
|
19
19
|
# template-info:
|
20
20
|
# manifest:
|
21
21
|
# tasks/unit_test.rake:
|
22
22
|
# safe-override: false
|
23
23
|
#
|
24
|
-
# More info about the TestTask and its options can be found on
|
24
|
+
# More info about the TestTask and its options can be found on
|
25
25
|
# http://rake.rubyforge.org/classes/Rake/TestTask.html
|
26
26
|
#
|
27
27
|
begin
|
@@ -36,7 +36,7 @@ begin
|
|
36
36
|
# True if verbose test output desired. (default is false)
|
37
37
|
t.verbose = false
|
38
38
|
|
39
|
-
# Test options passed to the test suite. An explicit TESTOPTS=opts
|
39
|
+
# Test options passed to the test suite. An explicit TESTOPTS=opts
|
40
40
|
# on the command line will override this. (default is NONE)
|
41
41
|
t.options = nil
|
42
42
|
|
@@ -52,10 +52,10 @@ begin
|
|
52
52
|
# * :rake -- Rake provided test loading script (default).
|
53
53
|
# * :testrb -- Ruby provided test loading script.
|
54
54
|
# * :direct -- Load tests using command line loader.
|
55
|
-
#
|
55
|
+
#
|
56
56
|
t.loader = :rake
|
57
57
|
|
58
|
-
# Array of commandline options to pass to ruby when running test
|
58
|
+
# Array of commandline options to pass to ruby when running test
|
59
59
|
# loader.
|
60
60
|
t.ruby_opts = []
|
61
61
|
|
@@ -74,4 +74,3 @@ ensure
|
|
74
74
|
desc "Run all tests"
|
75
75
|
task :test => [:unit_test]
|
76
76
|
end
|
77
|
-
|
data/tasks/yard.rake
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Installs a rake task to generate API documentation using yard.
|
2
2
|
#
|
3
|
-
# This file installs the 'rake yard' task. It is automatically generated by Noe from
|
4
|
-
# your .noespec file, and should therefore be configured there, under the
|
3
|
+
# This file installs the 'rake yard' task. It is automatically generated by Noe from
|
4
|
+
# your .noespec file, and should therefore be configured there, under the
|
5
5
|
# variables/rake_tasks/yard entry, as illustrated below:
|
6
6
|
#
|
7
7
|
# variables:
|
@@ -11,15 +11,15 @@
|
|
11
11
|
# options: []
|
12
12
|
# ...
|
13
13
|
#
|
14
|
-
# If you have specific needs requiring manual intervention on this file,
|
14
|
+
# If you have specific needs requiring manual intervention on this file,
|
15
15
|
# don't forget to set safe-override to false in your noe specification:
|
16
|
-
#
|
16
|
+
#
|
17
17
|
# template-info:
|
18
18
|
# manifest:
|
19
19
|
# tasks/yard.rake:
|
20
20
|
# safe-override: false
|
21
21
|
#
|
22
|
-
# This file has been written to conform to yard v0.6.4. More information about
|
22
|
+
# This file has been written to conform to yard v0.6.4. More information about
|
23
23
|
# yard and the rake task installed below can be found on http://yardoc.org/
|
24
24
|
#
|
25
25
|
begin
|
@@ -28,20 +28,20 @@ begin
|
|
28
28
|
YARD::Rake::YardocTask.new(:yard) do |t|
|
29
29
|
# Array of options passed to yardoc commandline. See 'yardoc --help' about this
|
30
30
|
t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
|
31
|
-
|
32
|
-
# Array of ruby source files (and any extra documentation files
|
31
|
+
|
32
|
+
# Array of ruby source files (and any extra documentation files
|
33
33
|
# separated by '-')
|
34
34
|
t.files = ["lib/**/*.rb"]
|
35
|
-
|
35
|
+
|
36
36
|
# A proc to call before running the task
|
37
37
|
# t.before = proc{ }
|
38
|
-
|
38
|
+
|
39
39
|
# A proc to call after running the task
|
40
40
|
# r.after = proc{ }
|
41
|
-
|
42
|
-
# An optional lambda to run against all objects being generated.
|
43
|
-
# Any object that the lambda returns false for will be excluded
|
44
|
-
# from documentation.
|
41
|
+
|
42
|
+
# An optional lambda to run against all objects being generated.
|
43
|
+
# Any object that the lambda returns false for will be excluded
|
44
|
+
# from documentation.
|
45
45
|
# t.verifier = lambda{|obj| true}
|
46
46
|
end
|
47
47
|
rescue LoadError
|
data/templates/ruby/CHANGELOG.md
CHANGED
data/templates/ruby/README.md
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# Noe template for ruby projects
|
2
2
|
|
3
|
-
This project provides a [Noe](https://github.com/blambeau/noe) template for creating a
|
4
|
-
ruby gem library. Generated project comes with rake tasks to support the lifecycle of
|
5
|
-
the library (testing, releasing, and so on). Following Noe's philosophy this template
|
3
|
+
This project provides a [Noe](https://github.com/blambeau/noe) template for creating a
|
4
|
+
ruby gem library. Generated project comes with rake tasks to support the lifecycle of
|
5
|
+
the library (testing, releasing, and so on). Following Noe's philosophy this template
|
6
6
|
also helps you understanding the ruby ecosystem by providing a fully documented project,
|
7
7
|
rake tasks, and so on.
|
8
8
|
|
@@ -22,36 +22,36 @@ In other words
|
|
22
22
|
# Prepare generation
|
23
23
|
noe prepare --template=ruby foo
|
24
24
|
cd foo
|
25
|
-
|
25
|
+
|
26
26
|
# Edit specific information about your project
|
27
27
|
edit foo.noespec
|
28
|
-
|
28
|
+
|
29
29
|
# Let Noe generate your project
|
30
30
|
noe go
|
31
|
-
|
32
|
-
# Install your ruby dependencies then run rake
|
31
|
+
|
32
|
+
# Install your ruby dependencies then run rake
|
33
33
|
bundle install
|
34
34
|
rake
|
35
|
-
|
35
|
+
|
36
36
|
## Rake tasks installed by this template
|
37
37
|
|
38
|
-
The following rake tasks are provided to your Rakefile by this template. Have a look at the
|
39
|
-
_tasks_ folder for specific configuration additional information.
|
38
|
+
The following rake tasks are provided to your Rakefile by this template. Have a look at the
|
39
|
+
_tasks_ folder for specific configuration additional information.
|
40
40
|
|
41
41
|
# Running tests
|
42
42
|
rake spec_test # Run RSpec code examples
|
43
43
|
rake unit_test # Run unit tests
|
44
44
|
rake test # spec_test & unit_test
|
45
|
-
|
45
|
+
|
46
46
|
# Generating documentation
|
47
47
|
rake yard # Generate YARD Documentation
|
48
|
-
|
48
|
+
|
49
49
|
# Releasing and packaging
|
50
50
|
rake gem # Build the gem file
|
51
51
|
rake package # Build all the packages
|
52
52
|
rake repackage # Force a rebuild of the package files
|
53
53
|
rake clobber_package # Remove package products
|
54
|
-
|
54
|
+
|
55
55
|
## External dependencies
|
56
56
|
|
57
57
|
* This template requires [bundler, >= 1.0](http://gembundler.com/)
|
data/templates/ruby/noespec.yaml
CHANGED
@@ -3,14 +3,14 @@
|
|
3
3
|
# It consists of two main sections: template-info and variables. The first one contains
|
4
4
|
# meta-information about the skeleton itself while the second one provides information
|
5
5
|
# about your library.
|
6
|
-
#
|
7
|
-
# Please update the first part with care, as it immediately affects the way Noe will
|
6
|
+
#
|
7
|
+
# Please update the first part with care, as it immediately affects the way Noe will
|
8
8
|
# manage the files of your own project. The second part may be updated more freely.
|
9
9
|
#
|
10
|
-
# Remember that your project may use a shorter version of this file as it will be
|
11
|
-
# automatically completed with default options when invoking 'noe go'. In particular,
|
12
|
-
# the first section (under template-info) is only required to contain the name and
|
13
|
-
# version of the template to use.
|
10
|
+
# Remember that your project may use a shorter version of this file as it will be
|
11
|
+
# automatically completed with default options when invoking 'noe go'. In particular,
|
12
|
+
# the first section (under template-info) is only required to contain the name and
|
13
|
+
# version of the template to use.
|
14
14
|
#
|
15
15
|
# Use 'noe prepare --template=!{template_name} --layout=short' to generate a shorter
|
16
16
|
# version of this file.
|
@@ -19,51 +19,51 @@
|
|
19
19
|
#
|
20
20
|
template-info:
|
21
21
|
|
22
|
-
# Don't remove the name and version entries, which are ALWAYS required
|
22
|
+
# Don't remove the name and version entries, which are ALWAYS required
|
23
23
|
name: "!{template_name}"
|
24
|
-
version: 1.5.
|
24
|
+
version: 1.5.1
|
25
25
|
|
26
|
-
# The following entries are information about the template itself and can safely
|
26
|
+
# The following entries are information about the template itself and can safely
|
27
27
|
# be removed on your own project.
|
28
28
|
summary: |
|
29
29
|
Template for creating a ruby gem following best ruby practices
|
30
30
|
description: |
|
31
|
-
This is a [Noe](https://github.com/blambeau/noe) template for creating a ruby gem
|
32
|
-
library. Generated project comes with rake tasks to support the lifecycle of the
|
33
|
-
library (testing, releasing, and so on). Following Noe philosophy this template
|
34
|
-
also helps you understanding the ruby ecosystem by providing a fully documented
|
31
|
+
This is a [Noe](https://github.com/blambeau/noe) template for creating a ruby gem
|
32
|
+
library. Generated project comes with rake tasks to support the lifecycle of the
|
33
|
+
library (testing, releasing, and so on). Following Noe philosophy this template
|
34
|
+
also helps you understanding the ruby ecosystem by providing a fully documented
|
35
35
|
project, rake tasks, and so on.
|
36
|
-
authors:
|
36
|
+
authors:
|
37
37
|
- {name: Bernard Lambeau, email: blambeau@gmail.com}
|
38
38
|
links:
|
39
39
|
source: https://github.com/blambeau/noe/tree/master/templates/ruby
|
40
40
|
documentation: https://github.com/blambeau/noe/blob/master/templates/ruby/README.md
|
41
|
-
|
41
|
+
|
42
42
|
#
|
43
|
-
# Below starts the template manifest.
|
43
|
+
# Below starts the template manifest.
|
44
44
|
#
|
45
45
|
# Each entry is related to a template file and may contain the following keys:
|
46
46
|
# - description: short explanation of the role the file plays in your project
|
47
47
|
# - safe-override: may the file be safely overrided by 'noe go --safe-override'?
|
48
|
-
# - wlang-dialect: what dialect must be used for wlang instantiation. When no
|
48
|
+
# - wlang-dialect: what dialect must be used for wlang instantiation. When no
|
49
49
|
# dialect is specified, the dialect under main-wlang-dialect is used.
|
50
50
|
#
|
51
51
|
# You can safely remove the whole manifest or entries for which the default values
|
52
52
|
# are ok for your project. Otherwise, values defined below override the default ones
|
53
|
-
# provided by the template.
|
53
|
+
# provided by the template.
|
54
54
|
#
|
55
|
-
# An typical example for keeping an entry here is to set safe-override to false for
|
55
|
+
# An typical example for keeping an entry here is to set safe-override to false for
|
56
56
|
# specific project files you want to manage manually.
|
57
57
|
#
|
58
58
|
manifest:
|
59
59
|
.gitignore:
|
60
60
|
description: Files to be ignored by git or another version control system
|
61
61
|
safe-override: false
|
62
|
-
__lower__.gemspec:
|
62
|
+
__lower__.gemspec:
|
63
63
|
description: Gem specification file
|
64
64
|
safe-override: true
|
65
65
|
wlang-dialect: wlang/ruby
|
66
|
-
CHANGELOG.md:
|
66
|
+
CHANGELOG.md:
|
67
67
|
description: Information about library changes
|
68
68
|
safe-override: false
|
69
69
|
Gemfile:
|
@@ -79,7 +79,7 @@ template-info:
|
|
79
79
|
lib/__lower__/loader.rb:
|
80
80
|
description: Dependency loader for the ruby library
|
81
81
|
safe-override: true
|
82
|
-
LICENCE.md:
|
82
|
+
LICENCE.md:
|
83
83
|
description: Licensing information
|
84
84
|
safe-override: false
|
85
85
|
Manifest.txt:
|
@@ -89,7 +89,7 @@ template-info:
|
|
89
89
|
description: Information for Ruby maker
|
90
90
|
safe-override: true
|
91
91
|
wlang-dialect: wlang/ruby
|
92
|
-
README.md:
|
92
|
+
README.md:
|
93
93
|
description: Starter documentation file
|
94
94
|
safe-override: false
|
95
95
|
spec/__lower__spec.rb:
|
@@ -123,39 +123,39 @@ template-info:
|
|
123
123
|
safe-override: true
|
124
124
|
wlang-dialect: wlang/ruby
|
125
125
|
|
126
|
-
# The following entries are template-related variables. Update to match your
|
126
|
+
# The following entries are template-related variables. Update to match your
|
127
127
|
# own configuration.
|
128
128
|
variables:
|
129
129
|
# A ruby lower case project name. This will become the name of the generated
|
130
130
|
# gem of the main ruby .rb start file and so on.
|
131
|
-
lower:
|
131
|
+
lower:
|
132
132
|
hello_world
|
133
133
|
|
134
134
|
# A ruby upper case project name. This is used to generate the main namespacing
|
135
|
-
# module of your project and shoul be the CamelCase equivalent of your lower
|
135
|
+
# module of your project and shoul be the CamelCase equivalent of your lower
|
136
136
|
# name.
|
137
137
|
upper:
|
138
138
|
HelloWorld
|
139
|
-
|
139
|
+
|
140
140
|
# Version of your library
|
141
141
|
version:
|
142
142
|
1.0.0
|
143
143
|
|
144
144
|
# Project summary (~ 1 line)
|
145
|
-
summary:
|
145
|
+
summary:
|
146
146
|
A simple "Hello World" example
|
147
|
-
|
147
|
+
|
148
148
|
# Project description (~ 5 lines). Project description should be more complete
|
149
149
|
# than the summary and will be used to describe your gem on rubygems.org
|
150
150
|
description: |-
|
151
151
|
This hello_world example provides you all you need to build a ruby gem library
|
152
152
|
while applying skeleton-driven coding with Noe (see http://revision-zero.org/noe)
|
153
|
-
|
154
|
-
# Authors of the project. Each author entry is a Hash and MUST at least have
|
155
|
-
# 'name' and 'email' keys. This is used to add meta information to your .gemspec
|
153
|
+
|
154
|
+
# Authors of the project. Each author entry is a Hash and MUST at least have
|
155
|
+
# 'name' and 'email' keys. This is used to add meta information to your .gemspec
|
156
156
|
# file. Example:
|
157
157
|
#
|
158
|
-
# authors:
|
158
|
+
# authors:
|
159
159
|
# - name: Bob
|
160
160
|
# email: bob@gmail.com
|
161
161
|
#
|
@@ -172,7 +172,7 @@ variables:
|
|
172
172
|
links: []
|
173
173
|
|
174
174
|
# Gem dependencies. Each entry is a Hash that MUST at least have 'name', 'version'
|
175
|
-
# and 'groups' keys. The later is an array of dependency groups and are used to
|
175
|
+
# and 'groups' keys. The later is an array of dependency groups and are used to
|
176
176
|
# generate Gemfile and .gemspec files. For now, only 'development' and 'runtime'
|
177
177
|
# values are supported.
|
178
178
|
#
|
@@ -184,31 +184,31 @@ variables:
|
|
184
184
|
# # WLang is required for both development and runtime
|
185
185
|
# - {name: wlang, version: ">= 0", groups: [runtime, development]}
|
186
186
|
#
|
187
|
-
dependencies:
|
187
|
+
dependencies:
|
188
188
|
# Rake is required for developers, as usual
|
189
189
|
- {name: rake, version: "~> 0.9.2", groups: [development]}
|
190
190
|
# Bundler is required for developers and is used by the Rakefile
|
191
191
|
- {name: bundler, version: "~> 1.0", groups: [development]}
|
192
|
-
# RSpec is required to run 'rake spec'. See tasks/spec.rake
|
192
|
+
# RSpec is required to run 'rake spec'. See tasks/spec.rake
|
193
193
|
- {name: rspec, version: "~> 2.6.0", groups: [development]}
|
194
|
-
# YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake
|
194
|
+
# YARD and BlueCloth are required to run 'rake yard'. See tasks/yard.rake
|
195
195
|
- {name: yard, version: "~> 0.7.2", groups: [development]}
|
196
196
|
- {name: bluecloth, version: "~> 2.1.0", groups: [development]}
|
197
197
|
# wlang is required to run 'rake debug_mail'. See tasks/debug_mail.rake
|
198
198
|
- {name: wlang, version: "~> 0.10.2", groups: [development]}
|
199
|
-
|
199
|
+
|
200
200
|
# Below are defined a certain number of specific variables for the .gemspec file
|
201
201
|
# of your library. We'll include it here to keep .gemspec under Noe's control for
|
202
202
|
# simple yet flexible cases. If your gem configuration is really specific, you
|
203
203
|
# can always maintain the .gemspec manually by setting
|
204
204
|
# template-info/manifest/__lower__.gemspec/safe-override to false
|
205
|
-
gemspec:
|
205
|
+
gemspec:
|
206
206
|
# Paths in the gem to add to $LOAD_PATH when the gem is activated (required).
|
207
207
|
require_paths: [ lib ]
|
208
208
|
# The path in the gem for executable scripts
|
209
209
|
bindir: 'bin'
|
210
|
-
# Array containing the names of executables included in the gem,
|
211
|
-
# if any (Dir[...] patterns are supported).
|
210
|
+
# Array containing the names of executables included in the gem,
|
211
|
+
# if any (Dir[...] patterns are supported).
|
212
212
|
executables: [ 'bin/*' ]
|
213
213
|
# Array of test files (Dir[...] patterns are supported).
|
214
214
|
test_files: ['test/**/*', 'spec/**/*']
|
@@ -216,13 +216,13 @@ variables:
|
|
216
216
|
rdoc_options: [ ]
|
217
217
|
# Array of extra files to give to rdoc (Dir[...] patterns are supported)
|
218
218
|
extra_rdoc_files: [ README.md, CHANGELOG.md, LICENCE.md ]
|
219
|
-
# Array of extensions to build when installing the gem.
|
219
|
+
# Array of extensions to build when installing the gem.
|
220
220
|
extensions: []
|
221
221
|
# External (to RubyGems) requirements that must be met for this gem to work (informal)
|
222
222
|
requirements:
|
223
223
|
# A friendly message you would like to display when the user installs your gem
|
224
224
|
post_install_message:
|
225
|
-
|
225
|
+
|
226
226
|
# Below are defined a certain number of specific variables for each rake task.
|
227
227
|
# Have a look at tasks/*.rake for additional details on each one.
|
228
228
|
rake_tasks:
|
@@ -251,12 +251,12 @@ variables:
|
|
251
251
|
# Pattern to find spec tests
|
252
252
|
pattern: spec/**/test_*.rb
|
253
253
|
# By default, if there is a Gemfile, the generated command will include
|
254
|
-
# 'bundle exec'. Set this to true to ignore the presence of a Gemfile,
|
254
|
+
# 'bundle exec'. Set this to true to ignore the presence of a Gemfile,
|
255
255
|
# and not add 'bundle exec' to the command.
|
256
256
|
skip_bundler: false
|
257
257
|
# Name of Gemfile to use
|
258
258
|
gemfile: Gemfile
|
259
|
-
# Whether or not to fail Rake when an error occurs (typically when
|
259
|
+
# Whether or not to fail Rake when an error occurs (typically when
|
260
260
|
# examples fail).
|
261
261
|
fail_on_error: true
|
262
262
|
# A message to print to stderr when there are failures.
|
@@ -270,7 +270,7 @@ variables:
|
|
270
270
|
rcov_path: rcov
|
271
271
|
# Command line options to pass to rcov. See 'rcov --help' about this
|
272
272
|
rcov_opts: []
|
273
|
-
# Command line options to pass to ruby. See 'ruby --help' about this
|
273
|
+
# Command line options to pass to ruby. See 'ruby --help' about this
|
274
274
|
ruby_opts: []
|
275
275
|
# Path to rspec
|
276
276
|
rspec_path: rspec
|
@@ -283,7 +283,7 @@ variables:
|
|
283
283
|
libs: [ lib ]
|
284
284
|
# True if verbose test output desired.
|
285
285
|
verbose: false
|
286
|
-
# Test options passed to the test suite. An explicit TESTOPTS=opts
|
286
|
+
# Test options passed to the test suite. An explicit TESTOPTS=opts
|
287
287
|
# on the command line will override this.
|
288
288
|
options:
|
289
289
|
# Request that the tests be run with the warning flag set.
|
@@ -294,7 +294,7 @@ variables:
|
|
294
294
|
# * :rake -- Rake provided test loading script (default).
|
295
295
|
# * :testrb -- Ruby provided test loading script.
|
296
296
|
# * :direct -- Load tests using command line loader.
|
297
|
-
#
|
297
|
+
#
|
298
298
|
loader: :rake
|
299
299
|
# Array of commandline options to pass to ruby when running test loader.
|
300
300
|
ruby_opts: []
|