-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jeremy McAnally
committed
Nov 10, 2012
0 parents
commit f32e884
Showing
20 changed files
with
716 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
source :rubygems | ||
|
||
gemspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License | ||
|
||
Copyright (c) Tom Preston-Werner | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
Fresno | ||
====== | ||
|
||
Fresno is a framework and generator for writing FRC controller code in [Mirah](http://mirah.org), a JVM language that compiles down to Java but offers a friendlier syntax. | ||
|
||
Installation | ||
------------ | ||
|
||
To get started, follow the instructions for setting up a Java environment in the [FRC Getting Started guide](http://www.usfirst.org/sites/default/files/uploadedFiles/Robotics_Programs/FRC/Game_and_Season__Info/2012_Assets/Getting%20Started%20with%20the%202012%20FRC%20Control%20System_2.pdf), including the updates for the Sun SPOT environment. | ||
|
||
Once you have Java setup along with the FRC dependencies, hop over to the [JRuby website](http://jruby.org) and install the JRuby package. Mirah uses JRuby as its language for parsing and compiling to Java, and Fresno uses it to run the generator code. | ||
|
||
To install Fresno, simply run `gem install fresno` (or `jgem install fresno`) with a JRuby powered installation of [RubyGems](http://rubygems.org), which should be installed by default with your JRuby package. | ||
|
||
Generator usage | ||
--------------- | ||
|
||
By default, Fresno's generator will create a directory structure and setup an [Ant](http://ant.apache.org) `build.xml` to build a project using WPILib's `IterativeRobot` class as its base. To create a project, simply execute: | ||
|
||
fresno create MyRobot | ||
|
||
...where MyRobot is the name of your robot/project. Fresno will then create a directory with the name of the robot/project and place inside of it a few files: | ||
|
||
* A `LICENSE` file with a license for the code contained within. By default, this is the [MIT Open Source License](http://opensource.org/licenses/MIT), but feel free to change or delete that file, especially if you never plan to open source your code. | ||
* A `LICENSE_FOR_WPI_LIB` file which contains the BSD license for all the WPILib code as required by its license. | ||
* A `build.xml` and `build.properties` file for building with Ant. These are heavily based on the files from WPILib's Netbeans templates with a few alterations and clarifications. | ||
* A `.gitignore` file to ignore build files when committing to a Git repository. | ||
* A `README.md` file in Markdown format; you should definitely keep a current `README` for your project! | ||
* A robot source file in `src`. | ||
|
||
To build your robot's code, execute `ant compile`. To deploy a new release, execute `ant deploy`. If you're using Netbeans, you can add a Netbeans project file to your Fresno project with the `--netbeans` option: | ||
|
||
fresno create MyRobot --netbeans | ||
|
||
If you'd like to use `SimpleRobot` as your base rather than `IterativeRobot`, you can specify the `--simple` option to the generator: | ||
|
||
fresno create MyRobot --simple | ||
|
||
A command based template is coming soon! | ||
|
||
Framework usage | ||
--------------- | ||
|
||
Currently, the Fresno framework isn't hooked into anything, and in reality, it's only a single class right now. | ||
|
||
Now that the generator is functional, features can begin to be added to the framework. In the future, the framework will be built at the time of the gem build (or install?) and then subsequently added to the classpath at build time. | ||
|
||
TODO | ||
---- | ||
|
||
* Implement the command template | ||
* Build out a bit of the convenience framework | ||
* Tweak the ant build so that we can build bytecode using Mirah and deploy that; otherwise, we lose a couple of the cool features of Mirah | ||
* Documentation! Documentation! Documentation! | ||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
require 'rubygems' | ||
require 'rake' | ||
require 'date' | ||
|
||
############################################################################# | ||
# | ||
# Helper functions | ||
# | ||
############################################################################# | ||
|
||
def name | ||
@name ||= Dir['*.gemspec'].first.split('.').first | ||
end | ||
|
||
def version | ||
line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/] | ||
line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1] | ||
end | ||
|
||
def date | ||
Date.today.to_s | ||
end | ||
|
||
def rubyforge_project | ||
name | ||
end | ||
|
||
def gemspec_file | ||
"#{name}.gemspec" | ||
end | ||
|
||
def gem_file | ||
"#{name}-#{version}.gem" | ||
end | ||
|
||
def replace_header(head, header_name) | ||
head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"} | ||
end | ||
|
||
############################################################################# | ||
# | ||
# Standard tasks | ||
# | ||
############################################################################# | ||
|
||
task :default => :test | ||
|
||
require 'rake/testtask' | ||
Rake::TestTask.new(:test) do |test| | ||
test.libs << 'lib' << 'test' | ||
test.pattern = 'test/**/test_*.rb' | ||
test.verbose = true | ||
end | ||
|
||
desc "Generate RCov test coverage and open in your browser" | ||
task :coverage do | ||
require 'rcov' | ||
sh "rm -fr coverage" | ||
sh "rcov test/test_*.rb" | ||
sh "open coverage/index.html" | ||
end | ||
|
||
require 'rake/rdoctask' | ||
Rake::RDocTask.new do |rdoc| | ||
rdoc.rdoc_dir = 'rdoc' | ||
rdoc.title = "#{name} #{version}" | ||
rdoc.rdoc_files.include('README*') | ||
rdoc.rdoc_files.include('lib/**/*.rb') | ||
end | ||
|
||
desc "Open an irb session preloaded with this library" | ||
task :console do | ||
sh "irb -rubygems -r ./lib/#{name}.rb" | ||
end | ||
|
||
############################################################################# | ||
# | ||
# Custom tasks (add your own tasks here) | ||
# | ||
############################################################################# | ||
|
||
|
||
|
||
############################################################################# | ||
# | ||
# Packaging tasks | ||
# | ||
############################################################################# | ||
|
||
desc "Create tag v#{version} and build and push #{gem_file} to Rubygems" | ||
task :release => :build do | ||
unless `git branch` =~ /^\* master$/ | ||
puts "You must be on the master branch to release!" | ||
exit! | ||
end | ||
sh "git commit --allow-empty -a -m 'Release #{version}'" | ||
sh "git tag v#{version}" | ||
sh "git push origin master" | ||
sh "git push origin v#{version}" | ||
sh "gem push pkg/#{name}-#{version}.gem" | ||
end | ||
|
||
desc "Build #{gem_file} into the pkg directory" | ||
task :build => :gemspec do | ||
sh "mkdir -p pkg" | ||
sh "gem build #{gemspec_file}" | ||
sh "mv #{gem_file} pkg" | ||
end | ||
|
||
desc "Generate #{gemspec_file}" | ||
task :gemspec => :validate do | ||
# read spec file and split out manifest section | ||
spec = File.read(gemspec_file) | ||
head, manifest, tail = spec.split(" # = MANIFEST =\n") | ||
|
||
# replace name version and date | ||
replace_header(head, :name) | ||
replace_header(head, :version) | ||
replace_header(head, :date) | ||
#comment this out if your rubyforge_project has a different name | ||
replace_header(head, :rubyforge_project) | ||
|
||
# determine file list from git ls-files | ||
files = `git ls-files`. | ||
split("\n"). | ||
sort. | ||
reject { |file| file =~ /^\./ }. | ||
reject { |file| file =~ /^(rdoc|pkg)/ }. | ||
map { |file| " #{file}" }. | ||
join("\n") | ||
|
||
# piece file back together and write | ||
manifest = " s.files = %w[\n#{files}\n ]\n" | ||
spec = [head, manifest, tail].join(" # = MANIFEST =\n") | ||
File.open(gemspec_file, 'w') { |io| io.write(spec) } | ||
puts "Updated #{gemspec_file}" | ||
end | ||
|
||
desc "Validate #{gemspec_file}" | ||
task :validate do | ||
libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"] | ||
unless libfiles.empty? | ||
puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir." | ||
exit! | ||
end | ||
unless Dir['VERSION*'].empty? | ||
puts "A `VERSION` file at root level violates Gem best practices." | ||
exit! | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
#!/usr/bin/env ruby | ||
require 'rubygems' | ||
require 'thor' | ||
|
||
$:.unshift File.join(File.dirname(__FILE__), '..', 'lib') | ||
require 'fresno' | ||
|
||
class FresnoCommand < Thor | ||
|
||
##################### | ||
# create - Create a new project directory and populate it with some basics | ||
# | ||
|
||
desc "create [ProjectName]", "Generates a new Fresno project" | ||
|
||
# Project templates | ||
method_options :netbeans => false, :desc => "Include NetBeans project" | ||
# TODO: Locate workable copy of Eclipse project... | ||
# method_options :eclipse => false, :desc => "Include Eclipse project" | ||
|
||
# Project skeletons | ||
method_options :iterative => true, :desc => "Create a basic iterative robot project" | ||
# TODO: Port and re-organize command driven code | ||
# method_options :command => false, :desc => "Create a command driven robot project" | ||
method_options :simple => false, :desc => "Create a 'simple' robot project" | ||
|
||
def create(project_name) | ||
Fresno::AppGenerator.new(@args, @options, @config).generate(project_name) | ||
end | ||
|
||
# | ||
##################### | ||
|
||
##################### | ||
# version - Give us a good bit of version info so we can debug easier | ||
# | ||
|
||
desc "version", "Shows the current version of Fresno" | ||
def version | ||
puts "Fresno v.#{Fresno::VERSION} running on #{RUBY_ENGINE rescue 'MRI'} #{JRUBY_VERSION rescue RUBY_VERSION} (#{RUBY_PLATFORM})" | ||
end | ||
|
||
# | ||
##################### | ||
end | ||
|
||
FresnoCommand.start |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
## This is the rakegem gemspec template. Make sure you read and understand | ||
## all of the comments. Some sections require modification, and others can | ||
## be deleted if you don't need them. Once you understand the contents of | ||
## this file, feel free to delete any comments that begin with two hash marks. | ||
## You can find comprehensive Gem::Specification documentation, at | ||
## http://docs.rubygems.org/read/chapter/20 | ||
Gem::Specification.new do |s| | ||
s.specification_version = 2 if s.respond_to? :specification_version= | ||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= | ||
s.rubygems_version = '1.3.5' | ||
s.platform = 'java' | ||
|
||
## Leave these as is they will be modified for you by the rake gemspec task. | ||
## If your rubyforge_project name is different, then edit it and comment out | ||
## the sub! line in the Rakefile | ||
s.name = 'fresno' | ||
s.version = '0.0.2' | ||
s.date = '2012-11-10' | ||
s.rubyforge_project = 'fresno' | ||
|
||
## Make sure your summary is short. The description may be as long | ||
## as you like. | ||
s.summary = "Framework for scripting FRC bots." | ||
s.description = "Framework for scripting FRC bots with Mirah." | ||
|
||
## List the primary authors. If there are a bunch of authors, it's probably | ||
## better to set the email to an email list or something. If you don't have | ||
## a custom homepage, consider using your GitHub URL or the like. | ||
s.authors = ["Jeremy McAnally"] | ||
s.email = 'jeremy@github.com' | ||
s.homepage = 'http://github.com/jm/fresno' | ||
|
||
## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as | ||
## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb' | ||
s.require_paths = %w[lib] | ||
|
||
## This sections is only necessary if you have C extensions. | ||
# s.require_paths << 'ext' | ||
# s.extensions = %w[ext/extconf.rb] | ||
|
||
## If your gem includes any executables, list them here. | ||
s.executables = ["fresno"] | ||
|
||
## Specify any RDoc options here. You'll want to add your README and | ||
## LICENSE files to the extra_rdoc_files list. | ||
s.rdoc_options = ["--charset=UTF-8"] | ||
s.extra_rdoc_files = %w[README.md LICENSE] | ||
|
||
## List your runtime dependencies here. Runtime dependencies are those | ||
## that are needed for an end user to actually USE your code. | ||
s.add_dependency('mirah') | ||
|
||
## List your development dependencies here. Development dependencies are | ||
## those that are only needed during development | ||
s.add_development_dependency('contest') | ||
|
||
## Leave this section as-is. It will be automatically generated from the | ||
## contents of your Git repository via the gemspec task. DO NOT REMOVE | ||
## THE MANIFEST COMMENTS, they are used as delimiters by the task. | ||
# = MANIFEST = | ||
s.files = %w[ | ||
|
||
] | ||
# = MANIFEST = | ||
|
||
## Test files will be grabbed from the file list. Make sure the path glob | ||
## matches what you actually use. | ||
s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ } | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
$:.unshift(File.dirname(__FILE__)) | ||
|
||
require 'fresno/app_generator' | ||
|
||
module Fresno | ||
VERSION = '0.0.2' | ||
end |
Oops, something went wrong.