From da83babb76adb61f78c4079f528a3600e8054834 Mon Sep 17 00:00:00 2001 From: Yaodong Zhao Date: Sat, 6 Feb 2016 07:53:26 -0700 Subject: [PATCH] Wrapped gem --- .gitignore | 9 +++++ .travis.yml | 4 +++ CODE_OF_CONDUCT.md | 49 ++++++++++++++++++++++++++++ Gemfile | 5 ++- Gemfile.lock | 17 ++++++++-- LICENSE.txt | 21 ++++++++++++ README.md | 35 ++++++++++++++++++-- Rakefile | 10 ++++++ bin/console | 14 ++++++++ bin/setup | 8 +++++ lib/ulysses.rb | 11 +++++++ {ulysses => lib/ulysses}/exporter.rb | 0 {ulysses => lib/ulysses}/group.rb | 0 {ulysses => lib/ulysses}/library.rb | 0 {ulysses => lib/ulysses}/sheet.rb | 0 lib/ulysses/version.rb | 3 ++ test/test_helper.rb | 4 +++ test/ulysses_test.rb | 11 +++++++ ulysses.gemspec | 30 +++++++++++++++++ ulysses.rb | 11 ------- 20 files changed, 223 insertions(+), 19 deletions(-) create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE.txt create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/ulysses.rb rename {ulysses => lib/ulysses}/exporter.rb (100%) rename {ulysses => lib/ulysses}/group.rb (100%) rename {ulysses => lib/ulysses}/library.rb (100%) rename {ulysses => lib/ulysses}/sheet.rb (100%) create mode 100644 lib/ulysses/version.rb create mode 100644 test/test_helper.rb create mode 100644 test/ulysses_test.rb create mode 100644 ulysses.gemspec delete mode 100644 ulysses.rb diff --git a/.gitignore b/.gitignore index e69de29..0cb6eeb 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1,9 @@ +/.bundle/ +/.yardoc +/Gemfile.lock +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..a5da5fa --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: ruby +rvm: + - 2.2.2 +before_install: gem install bundler -v 1.11.2 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..72c5203 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,49 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +By adopting this Code of Conduct, project maintainers commit themselves to +fairly and consistently applying these principles to every aspect of managing +this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting a project maintainer at y@whir.org. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. Maintainers are +obligated to maintain confidentiality with regard to the reporter of an +incident. + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.3.0, available at +[http://contributor-covenant.org/version/1/3/0/][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/3/0/ \ No newline at end of file diff --git a/Gemfile b/Gemfile index ba9ab9b..44b24a2 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,4 @@ source 'https://rubygems.org' -gem 'nokogiri' -gem 'kramdown' -gem 'htmlentities' +# Specify your gem's dependencies in ulysses.gemspec +gemspec diff --git a/Gemfile.lock b/Gemfile.lock index 240bd42..ac2982a 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,19 +1,30 @@ +PATH + remote: . + specs: + ulysses (0.3.0) + htmlentities + kramdown + nokogiri + GEM remote: https://rubygems.org/ specs: htmlentities (4.3.4) kramdown (1.9.0) mini_portile2 (2.0.0) + minitest (5.8.4) nokogiri (1.6.7.2) mini_portile2 (~> 2.0.0.rc2) + rake (10.5.0) PLATFORMS ruby DEPENDENCIES - htmlentities - kramdown - nokogiri + bundler (~> 1.11) + minitest (~> 5.0) + rake (~> 10.0) + ulysses! BUNDLED WITH 1.11.2 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..9f47737 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 Yaodong Zhao + +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. diff --git a/README.md b/README.md index 40827ee..2c02b68 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ -# ulysses.rb +# Ulysses This is a library to export your to HTML files. It still in development. -## Examples +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'ulysses' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install ulysses + +## Usage Get your library: @@ -25,3 +41,18 @@ Export sheet to HTML: sheet = group.sheets.first html = sheet.to_html + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/yaodong/gem-ulysses. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. + + +## License + +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..912ee38 --- /dev/null +++ b/Rakefile @@ -0,0 +1,10 @@ +require "bundler/gem_tasks" +require "rake/testtask" + +Rake::TestTask.new(:test) do |t| + t.libs << "test" + t.libs << "lib" + t.test_files = FileList['test/**/*_test.rb'] +end + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..3aff6ea --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "ulysses" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/lib/ulysses.rb b/lib/ulysses.rb new file mode 100644 index 0000000..a4fbcb4 --- /dev/null +++ b/lib/ulysses.rb @@ -0,0 +1,11 @@ +require 'nokogiri' +require 'htmlentities' +require 'kramdown' +require 'ulysses/library' +require 'ulysses/group' +require 'ulysses/sheet' +require 'ulysses/exporter' + +module Ulysses + +end diff --git a/ulysses/exporter.rb b/lib/ulysses/exporter.rb similarity index 100% rename from ulysses/exporter.rb rename to lib/ulysses/exporter.rb diff --git a/ulysses/group.rb b/lib/ulysses/group.rb similarity index 100% rename from ulysses/group.rb rename to lib/ulysses/group.rb diff --git a/ulysses/library.rb b/lib/ulysses/library.rb similarity index 100% rename from ulysses/library.rb rename to lib/ulysses/library.rb diff --git a/ulysses/sheet.rb b/lib/ulysses/sheet.rb similarity index 100% rename from ulysses/sheet.rb rename to lib/ulysses/sheet.rb diff --git a/lib/ulysses/version.rb b/lib/ulysses/version.rb new file mode 100644 index 0000000..d8de345 --- /dev/null +++ b/lib/ulysses/version.rb @@ -0,0 +1,3 @@ +module Ulysses + VERSION = '0.3.0' +end diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..11a5b6d --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,4 @@ +$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) +require 'ulysses' + +require 'minitest/autorun' diff --git a/test/ulysses_test.rb b/test/ulysses_test.rb new file mode 100644 index 0000000..9a72df8 --- /dev/null +++ b/test/ulysses_test.rb @@ -0,0 +1,11 @@ +require 'test_helper' + +class UlyssesTest < Minitest::Test + def test_that_it_has_a_version_number + refute_nil ::Ulysses::VERSION + end + + def test_it_does_something_useful + assert false + end +end diff --git a/ulysses.gemspec b/ulysses.gemspec new file mode 100644 index 0000000..6575c6b --- /dev/null +++ b/ulysses.gemspec @@ -0,0 +1,30 @@ +# coding: utf-8 +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'ulysses/version' + +Gem::Specification.new do |spec| + spec.name = "ulysses" + spec.version = Ulysses::VERSION + spec.authors = ["Yaodong Zhao"] + spec.email = ["y@whir.org"] + + spec.summary = 'Access ulysses library by ruby' + spec.description = 'Access ulysses library by ruby' + spec.homepage = 'https://github.com/yaodong/gem-ulysses' + spec.license = "MIT" + + spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_dependency 'nokogiri' + spec.add_dependency 'kramdown' + spec.add_dependency 'htmlentities' + + spec.add_development_dependency "bundler", "~> 1.11" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "minitest", "~> 5.0" + +end diff --git a/ulysses.rb b/ulysses.rb deleted file mode 100644 index c72e1ce..0000000 --- a/ulysses.rb +++ /dev/null @@ -1,11 +0,0 @@ -require 'nokogiri' -require 'htmlentities' -require 'kramdown' -require_relative 'ulysses/library' -require_relative 'ulysses/group' -require_relative 'ulysses/sheet' -require_relative 'ulysses/exporter' - -module Ulysses - -end