factory_generator 0.1.0
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 +19 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +41 -0
- data/Rakefile +6 -0
- data/bin/factory_generator +4 -0
- data/factory_generator.gemspec +21 -0
- data/lib/factory_generator.rb +18 -0
- data/lib/factory_generator/file_parser.rb +37 -0
- data/lib/factory_generator/gen_files_finder.rb +6 -0
- data/lib/factory_generator/java_code_generator.rb +40 -0
- data/lib/factory_generator/version.rb +3 -0
- data/test/test_file_parser.rb +61 -0
- data/test/test_gen_files_finder.rb +15 -0
- data/test/test_java_code_generator.rb +51 -0
- metadata +96 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Adam Niedzielski
|
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,41 @@
|
|
1
|
+
# FactoryGenerator
|
2
|
+
|
3
|
+
factory_generator is a simple tool for auto-generating Java factories.
|
4
|
+
It can be useful for applying dependency injection in your projects.
|
5
|
+
Describe your dependences in .generate file and it will create boilerplate code for you.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'factory_generator'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install factory_generator
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Create MySuperFactory.generate file in the directory (package) where you want to have a factory.
|
24
|
+
Describe each class in a single line like this:
|
25
|
+
dependee dependency1 dependency2 ... dependencyN
|
26
|
+
If a class does not have any dependency write only its name in a single line.
|
27
|
+
Remember to put class name along with package name like: com.example.project.model.MyModel (will be soon simplified)
|
28
|
+
|
29
|
+
## Contributing
|
30
|
+
|
31
|
+
1. Fork it
|
32
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
33
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
34
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
35
|
+
5. Create new Pull Request
|
36
|
+
|
37
|
+
## Future
|
38
|
+
|
39
|
+
1. Simplify package issue
|
40
|
+
2. C++ code generation as alternative to Java
|
41
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'factory_generator/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "factory_generator"
|
8
|
+
gem.version = FactoryGenerator::VERSION
|
9
|
+
gem.authors = ["Adam Niedzielski"]
|
10
|
+
gem.email = ["adamsunday@gmail.com"]
|
11
|
+
gem.description = %q{Simple tool for autogenerating Java Factories from text files}
|
12
|
+
gem.summary = %q{Simple tool for autogenerating Java Factories from text files}
|
13
|
+
gem.homepage = ""
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
|
+
gem.require_paths = ["lib"]
|
19
|
+
gem.add_development_dependency 'rake'
|
20
|
+
gem.add_development_dependency 'minitest'
|
21
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
require "factory_generator/version"
|
2
|
+
require "factory_generator/gen_files_finder"
|
3
|
+
require "factory_generator/file_parser"
|
4
|
+
require "factory_generator/java_code_generator"
|
5
|
+
|
6
|
+
module FactoryGenerator
|
7
|
+
def self.run
|
8
|
+
gen_files_finder = GenFilesFinder.new
|
9
|
+
gen_files = gen_files_finder.get_all_files
|
10
|
+
gen_files.each do |file|
|
11
|
+
parser = FileParser.new(file)
|
12
|
+
if parser.update_required?
|
13
|
+
generator = JavaCodeGenerator.new(parser)
|
14
|
+
generator.save(file)
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
class FactoryGenerator::FileParser
|
2
|
+
|
3
|
+
def initialize(file_name)
|
4
|
+
@file_name = file_name
|
5
|
+
@file = File.new(file_name)
|
6
|
+
@extension = "java"
|
7
|
+
end
|
8
|
+
|
9
|
+
def get_dependency_graph
|
10
|
+
generate_dependency_graph
|
11
|
+
end
|
12
|
+
|
13
|
+
def get_extension
|
14
|
+
@extension
|
15
|
+
end
|
16
|
+
|
17
|
+
def update_required?
|
18
|
+
factory_file_name = @file_name.sub("generate", @extension)
|
19
|
+
if File.exists?(factory_file_name)
|
20
|
+
if File.mtime(factory_file_name) > @file.mtime
|
21
|
+
return false
|
22
|
+
end
|
23
|
+
end
|
24
|
+
return true
|
25
|
+
end
|
26
|
+
|
27
|
+
private
|
28
|
+
|
29
|
+
def generate_dependency_graph
|
30
|
+
@dependency_graph = Hash.new()
|
31
|
+
@file.each_line() do |line|
|
32
|
+
line = line.split
|
33
|
+
@dependency_graph[line.first] = line.drop(1)
|
34
|
+
end
|
35
|
+
return @dependency_graph
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
class FactoryGenerator::JavaCodeGenerator
|
2
|
+
|
3
|
+
def initialize(parser, file_name)
|
4
|
+
@dependency_graph = parser.get_dependency_graph
|
5
|
+
@extension = parser.get_extension
|
6
|
+
@file_name = file_name
|
7
|
+
end
|
8
|
+
|
9
|
+
def save()
|
10
|
+
factory_file_name = @file_name.sub("generate", @extension)
|
11
|
+
File.open(factory_file_name, "w") do |file|
|
12
|
+
file.write generate_content
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
private
|
17
|
+
|
18
|
+
def generate_content()
|
19
|
+
content = generate_header
|
20
|
+
@dependency_graph.each() do |dependee, dependencies|
|
21
|
+
content << " public static " + dependee + " get" + dependee.split(".").last + "(){\n"
|
22
|
+
content << "\treturn new " + dependee + "("
|
23
|
+
dependencies.each_with_index do |dependency, index|
|
24
|
+
content << "get" + dependency + "()"
|
25
|
+
content << ", " if index != dependencies.size - 1
|
26
|
+
end
|
27
|
+
content << ");\n }\n\n"
|
28
|
+
end
|
29
|
+
content << "}"
|
30
|
+
return content
|
31
|
+
end
|
32
|
+
|
33
|
+
def generate_header
|
34
|
+
package_name = @file_name.split("src/").last.split("/").reverse.drop(1).reverse.join(".")
|
35
|
+
content = "package " + package_name + ";\n\n"
|
36
|
+
class_name = @file_name.split("/").last.sub(".generate", "") + " {\n\n"
|
37
|
+
content << "public class " + class_name
|
38
|
+
return content
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
gem 'minitest'
|
2
|
+
require "minitest/autorun"
|
3
|
+
require "factory_generator"
|
4
|
+
require "tempfile"
|
5
|
+
|
6
|
+
class TestFileParser < MiniTest::Unit::TestCase
|
7
|
+
|
8
|
+
def test_default_extension
|
9
|
+
file = Tempfile.new(["test", ".generate"])
|
10
|
+
parser = FactoryGenerator::FileParser.new(file.path())
|
11
|
+
assert_equal("java", parser.get_extension)
|
12
|
+
end
|
13
|
+
|
14
|
+
def test_update_required?
|
15
|
+
random_string = rand(1000000).to_s
|
16
|
+
file_gen_name = random_string + "test.generate"
|
17
|
+
file_factory_name = random_string + "test.java"
|
18
|
+
Dir.chdir(Dir.tmpdir()) do
|
19
|
+
begin
|
20
|
+
File.open(file_gen_name, "w") do |file|
|
21
|
+
file.puts "test"
|
22
|
+
end
|
23
|
+
|
24
|
+
parser = FactoryGenerator::FileParser.new(file_gen_name)
|
25
|
+
assert_equal(true, parser.update_required?)
|
26
|
+
|
27
|
+
sleep 1
|
28
|
+
File.open(file_factory_name, "w") do |file|
|
29
|
+
file.puts "test"
|
30
|
+
end
|
31
|
+
|
32
|
+
assert_equal(false, parser.update_required?)
|
33
|
+
|
34
|
+
sleep 1
|
35
|
+
File.open(file_gen_name, "w") do |file|
|
36
|
+
file.puts "test"
|
37
|
+
end
|
38
|
+
|
39
|
+
assert_equal(true, parser.update_required?)
|
40
|
+
ensure
|
41
|
+
File.delete(file_gen_name) if File.exist?(file_gen_name)
|
42
|
+
File.delete(file_factory_name) if File.exist?(file_factory_name)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
47
|
+
|
48
|
+
def test_get_dependency_graph
|
49
|
+
file = Tempfile.new(["test", ".generate"])
|
50
|
+
file.puts "First Second Third"
|
51
|
+
file.puts "Second Fourth"
|
52
|
+
file.puts "Third"
|
53
|
+
file.close
|
54
|
+
expected_graph = {"First" => ["Second", "Third"],
|
55
|
+
"Second" => ["Fourth"], "Third" => []}
|
56
|
+
|
57
|
+
parser = FactoryGenerator::FileParser.new(file)
|
58
|
+
assert_equal(expected_graph, parser.get_dependency_graph)
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
gem 'minitest'
|
2
|
+
require "minitest/autorun"
|
3
|
+
require "factory_generator"
|
4
|
+
|
5
|
+
class TestGenFilesFinder < MiniTest::Unit::TestCase
|
6
|
+
def test_get_all_files
|
7
|
+
Dir.chdir(Dir.tmpdir()) do
|
8
|
+
File.open("test.generate", "w") do
|
9
|
+
end
|
10
|
+
gen_files_finder = FactoryGenerator::GenFilesFinder.new()
|
11
|
+
assert(gen_files_finder.get_all_files.include?("test.generate"))
|
12
|
+
File.delete("test.generate")
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
gem 'minitest'
|
2
|
+
require "minitest/autorun"
|
3
|
+
require "factory_generator"
|
4
|
+
|
5
|
+
class TestJavaCodeGenerator < MiniTest::Unit::TestCase
|
6
|
+
|
7
|
+
def setup
|
8
|
+
@parser = MiniTest::Mock.new()
|
9
|
+
end
|
10
|
+
|
11
|
+
def test_save
|
12
|
+
@parser.expect(:get_extension, "test")
|
13
|
+
@parser.expect(:get_dependency_graph, Hash.new)
|
14
|
+
generator = FactoryGenerator::JavaCodeGenerator.new(@parser, "test.generate")
|
15
|
+
@parser.verify
|
16
|
+
Dir.chdir(Dir.tmpdir()) do
|
17
|
+
generator.save
|
18
|
+
assert(File.exist?("test.test"))
|
19
|
+
File.delete("test.test") if File.exist?("test.test")
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def test_get_content
|
24
|
+
graph = {"First" => ["Second", "Third"], "Second" => ["Fourth"], "Third" => []}
|
25
|
+
@parser.expect(:get_extension, "java")
|
26
|
+
@parser.expect(:get_dependency_graph, graph)
|
27
|
+
generator = FactoryGenerator::JavaCodeGenerator.new(@parser, "src/com/example/test.generate")
|
28
|
+
@parser.verify
|
29
|
+
actual_content = generator.send(:generate_content).gsub(/\s+/, "")
|
30
|
+
expected_content = %!
|
31
|
+
package com.example;
|
32
|
+
|
33
|
+
public class test{
|
34
|
+
|
35
|
+
public static First getFirst(){
|
36
|
+
return new First(getSecond(), getThird());
|
37
|
+
}
|
38
|
+
|
39
|
+
public static Second getSecond(){
|
40
|
+
return new Second(getFourth());
|
41
|
+
}
|
42
|
+
|
43
|
+
public static Third getThird(){
|
44
|
+
return new Third();
|
45
|
+
}
|
46
|
+
|
47
|
+
}!.gsub(/\s+/, "")
|
48
|
+
|
49
|
+
assert_equal(expected_content, actual_content)
|
50
|
+
end
|
51
|
+
end
|
metadata
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: factory_generator
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Adam Niedzielski
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-02-19 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: rake
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :development
|
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: minitest
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
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: '0'
|
46
|
+
description: Simple tool for autogenerating Java Factories from text files
|
47
|
+
email:
|
48
|
+
- adamsunday@gmail.com
|
49
|
+
executables:
|
50
|
+
- factory_generator
|
51
|
+
extensions: []
|
52
|
+
extra_rdoc_files: []
|
53
|
+
files:
|
54
|
+
- .gitignore
|
55
|
+
- Gemfile
|
56
|
+
- LICENSE.txt
|
57
|
+
- README.md
|
58
|
+
- Rakefile
|
59
|
+
- bin/factory_generator
|
60
|
+
- factory_generator.gemspec
|
61
|
+
- lib/factory_generator.rb
|
62
|
+
- lib/factory_generator/file_parser.rb
|
63
|
+
- lib/factory_generator/gen_files_finder.rb
|
64
|
+
- lib/factory_generator/java_code_generator.rb
|
65
|
+
- lib/factory_generator/version.rb
|
66
|
+
- test/test_file_parser.rb
|
67
|
+
- test/test_gen_files_finder.rb
|
68
|
+
- test/test_java_code_generator.rb
|
69
|
+
homepage: ''
|
70
|
+
licenses: []
|
71
|
+
post_install_message:
|
72
|
+
rdoc_options: []
|
73
|
+
require_paths:
|
74
|
+
- lib
|
75
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
76
|
+
none: false
|
77
|
+
requirements:
|
78
|
+
- - ! '>='
|
79
|
+
- !ruby/object:Gem::Version
|
80
|
+
version: '0'
|
81
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
82
|
+
none: false
|
83
|
+
requirements:
|
84
|
+
- - ! '>='
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
requirements: []
|
88
|
+
rubyforge_project:
|
89
|
+
rubygems_version: 1.8.23
|
90
|
+
signing_key:
|
91
|
+
specification_version: 3
|
92
|
+
summary: Simple tool for autogenerating Java Factories from text files
|
93
|
+
test_files:
|
94
|
+
- test/test_file_parser.rb
|
95
|
+
- test/test_gen_files_finder.rb
|
96
|
+
- test/test_java_code_generator.rb
|