stein 0.0.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/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +86 -0
- data/Rakefile +1 -0
- data/lib/stein.rb +16 -0
- data/lib/stein/version.rb +3 -0
- data/stein.gemspec +25 -0
- metadata +102 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Artem Baguinski
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
# Stein
|
2
|
+
|
3
|
+
A micro gem that allows [Main][] modes be written in separate files and magically
|
4
|
+
stitched together.
|
5
|
+
|
6
|
+
This may become convenient whem your utility becomes monstrously large
|
7
|
+
(*8-foot-tall (2.4 m), hideously ugly creation, with translucent yellowish skin
|
8
|
+
pulled so taut over the body that it "barely disguised the workings of the
|
9
|
+
vessels and muscles underneath"; watery, glowing eyes, flowing black hair,
|
10
|
+
black lips, and prominent white teeth.*)
|
11
|
+
|
12
|
+
[Main]: https://github.com/ahoward/main
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
Add this line to your application's Gemfile:
|
17
|
+
|
18
|
+
gem 'stein'
|
19
|
+
|
20
|
+
And then execute:
|
21
|
+
|
22
|
+
$ bundle
|
23
|
+
|
24
|
+
Or install it yourself as:
|
25
|
+
|
26
|
+
$ gem install stein
|
27
|
+
|
28
|
+
## Usage
|
29
|
+
|
30
|
+
Start with the main "body" of the utility:
|
31
|
+
|
32
|
+
**bin/frankenstein**
|
33
|
+
|
34
|
+
```
|
35
|
+
#!/usr/bin/env ruby
|
36
|
+
require 'main'
|
37
|
+
require 'stein'
|
38
|
+
|
39
|
+
$LIB_DIR = File.dirname(File.dirname __FILE__) + '/lib'
|
40
|
+
|
41
|
+
Main {
|
42
|
+
description "Show how to build a monster utility from a bunch of modes"
|
43
|
+
def run ; help! ; end
|
44
|
+
Stein.extend self, $LIB_DIR + 'modes'
|
45
|
+
}
|
46
|
+
```
|
47
|
+
|
48
|
+
Then place your modes in lib/modes/:
|
49
|
+
|
50
|
+
**lib/modes/feed.rb**
|
51
|
+
|
52
|
+
```
|
53
|
+
Stein.mode 'feed' do
|
54
|
+
description "Go to the village and steal some food"
|
55
|
+
def run
|
56
|
+
go(village)
|
57
|
+
food = steal
|
58
|
+
eat(food)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
That's it.
|
64
|
+
|
65
|
+
### API Reference
|
66
|
+
|
67
|
+
**Stein.mode mode_name, &block**: can be used in the top level of a mode-file (a
|
68
|
+
ruby file in modes directory). It delegates itself to Main DSL's `mode`,
|
69
|
+
eventually.
|
70
|
+
|
71
|
+
**Stein.extend main_module, modes_directory**: loads all modes definitions from
|
72
|
+
the directory.
|
73
|
+
|
74
|
+
## Acknowledgements
|
75
|
+
|
76
|
+
Thanks to Ara T. Howard for Main.
|
77
|
+
|
78
|
+
Thanks to Mary Shelly for the book.
|
79
|
+
|
80
|
+
## Contributing
|
81
|
+
|
82
|
+
1. Fork it
|
83
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
84
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
85
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
86
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/stein.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require "stein/version"
|
2
|
+
|
3
|
+
module Stein
|
4
|
+
Patches = []
|
5
|
+
|
6
|
+
def Stein.mode *args, &block
|
7
|
+
Stein::Patches << proc { mode *args, &block }
|
8
|
+
end
|
9
|
+
|
10
|
+
def Stein.extend main, modes_dir
|
11
|
+
Dir["#{modes_dir}/*.rb"].each do |mode|
|
12
|
+
load mode
|
13
|
+
end
|
14
|
+
Stein::Patches.each {|patch| main.module_eval &patch}
|
15
|
+
end
|
16
|
+
end
|
data/stein.gemspec
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'stein/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "stein"
|
8
|
+
spec.version = Stein::VERSION
|
9
|
+
spec.authors = ["Artem Baguinski"]
|
10
|
+
spec.email = ["femistofel@gmail.com"]
|
11
|
+
spec.description = %q{Write Main modes in separate source files}
|
12
|
+
spec.summary = %q{Write Main modes in separate source files}
|
13
|
+
spec.homepage = "https://github.com/artm/stein"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "main"
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
end
|
metadata
ADDED
@@ -0,0 +1,102 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: stein
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Artem Baguinski
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-03-27 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: main
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: bundler
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '1.3'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '1.3'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: rake
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
description: Write Main modes in separate source files
|
63
|
+
email:
|
64
|
+
- femistofel@gmail.com
|
65
|
+
executables: []
|
66
|
+
extensions: []
|
67
|
+
extra_rdoc_files: []
|
68
|
+
files:
|
69
|
+
- .gitignore
|
70
|
+
- Gemfile
|
71
|
+
- LICENSE.txt
|
72
|
+
- README.md
|
73
|
+
- Rakefile
|
74
|
+
- lib/stein.rb
|
75
|
+
- lib/stein/version.rb
|
76
|
+
- stein.gemspec
|
77
|
+
homepage: https://github.com/artm/stein
|
78
|
+
licenses:
|
79
|
+
- MIT
|
80
|
+
post_install_message:
|
81
|
+
rdoc_options: []
|
82
|
+
require_paths:
|
83
|
+
- lib
|
84
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
85
|
+
none: false
|
86
|
+
requirements:
|
87
|
+
- - ! '>='
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
91
|
+
none: false
|
92
|
+
requirements:
|
93
|
+
- - ! '>='
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
requirements: []
|
97
|
+
rubyforge_project:
|
98
|
+
rubygems_version: 1.8.23
|
99
|
+
signing_key:
|
100
|
+
specification_version: 3
|
101
|
+
summary: Write Main modes in separate source files
|
102
|
+
test_files: []
|