From 782749893c0e26814f446c1b7ac32644558ab36e Mon Sep 17 00:00:00 2001 From: Ervan Silvert Date: Sat, 15 Jan 2022 14:52:22 +0100 Subject: [PATCH] :sparkles: Gem creation + hello world pdf --- .gitignore | 11 ++++++++ .rspec | 3 ++ .ruby-version | 1 + .travis.yml | 7 +++++ Gemfile | 10 +++++++ Gemfile.lock | 47 ++++++++++++++++++++++++++++++++ LICENSE.txt | 21 ++++++++++++++ README.md | 39 ++++++++++++++++++++++++++ Rakefile | 6 ++++ agenda_pdf.gemspec | 44 ++++++++++++++++++++++++++++++ bin/agenda_pdf | 4 +++ bin/console | 14 ++++++++++ bin/setup | 8 ++++++ lib/agenda_pdf.rb | 18 ++++++++++++ lib/agenda_pdf/options_parser.rb | 46 +++++++++++++++++++++++++++++++ lib/agenda_pdf/pdf_generator.rb | 21 ++++++++++++++ lib/agenda_pdf/version.rb | 3 ++ spec/agenda_pdf_spec.rb | 9 ++++++ spec/spec_helper.rb | 14 ++++++++++ 19 files changed, 326 insertions(+) create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .ruby-version create mode 100644 .travis.yml create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100644 agenda_pdf.gemspec create mode 100755 bin/agenda_pdf create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/agenda_pdf.rb create mode 100644 lib/agenda_pdf/options_parser.rb create mode 100644 lib/agenda_pdf/pdf_generator.rb create mode 100644 lib/agenda_pdf/version.rb create mode 100644 spec/agenda_pdf_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b04a8c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 0000000..d9c62ed --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +3.0.2 \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2c49231 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +--- +sudo: false +language: ruby +cache: bundler +rvm: + - 2.6.3 +before_install: gem install bundler -v 1.17.2 diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..c8861e9 --- /dev/null +++ b/Gemfile @@ -0,0 +1,10 @@ +source "https://rubygems.org" + +git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } + +# Specify your gem's dependencies in agenda_pdf.gemspec +gemspec + +gem 'prawn', '~> 2.4' + +ruby '3.0.2' diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..2da61f9 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,47 @@ +PATH + remote: . + specs: + agenda_pdf (0.1.0) + prawn (~> 2.4) + +GEM + remote: https://rubygems.org/ + specs: + diff-lcs (1.5.0) + pdf-core (0.9.0) + prawn (2.4.0) + pdf-core (~> 0.9.0) + ttfunk (~> 1.7) + rake (10.5.0) + rspec (3.10.0) + rspec-core (~> 3.10.0) + rspec-expectations (~> 3.10.0) + rspec-mocks (~> 3.10.0) + rspec-core (3.10.1) + rspec-support (~> 3.10.0) + rspec-expectations (3.10.2) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.10.0) + rspec-mocks (3.10.2) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.10.0) + rspec-support (3.10.3) + thor (1.2.1) + ttfunk (1.7.0) + +PLATFORMS + ruby + +DEPENDENCIES + agenda_pdf! + bundler (~> 2.2.22) + prawn (~> 2.4) + rake (~> 10.0) + rspec (~> 3.0) + thor (~> 1.2) + +RUBY VERSION + ruby 3.0.2p107 + +BUNDLED WITH + 2.2.22 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c85c0cd --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2022 Ervan Silvert + +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 new file mode 100644 index 0000000..33ca746 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# AgendaPdf + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/agenda_pdf`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'agenda_pdf' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install agenda_pdf + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/agenda_pdf. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b7e9ed5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/agenda_pdf.gemspec b/agenda_pdf.gemspec new file mode 100644 index 0000000..e5ca4e4 --- /dev/null +++ b/agenda_pdf.gemspec @@ -0,0 +1,44 @@ + +lib = File.expand_path("../lib", __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require "agenda_pdf/version" + +Gem::Specification.new do |spec| + spec.name = "agenda_pdf" + spec.version = AgendaPdf::VERSION + spec.authors = ["Ervan Silvert"] + spec.email = ["ervan@derniercri.io"] + + spec.summary = %q{Allows to create a pdf file for each day of a period} + spec.description = %q{Allows to create a pdf file for each day of a period} + spec.homepage = "https://gitlab.com/esilvert/agenda_pdf" + spec.license = "MIT" + + # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' + # to allow pushing to a single host or delete this section to allow pushing to any host. + if spec.respond_to?(:metadata) + spec.metadata["allowed_push_host"] = "https://gitlab.com/esilvert/agenda_pdf/CHANGELOG.md" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "https://gitlab.com/esilvert/agenda_pdf/CHANGELOG.md" + spec.metadata["changelog_uri"] = "https://gitlab.com/esilvert/agenda_pdf/CHANGELOG.md" + else + raise "RubyGems 2.0 or newer is required to protect against " \ + "public gem pushes." + end + + # Specify which files should be added to the gem when it is released. + # The `git ls-files -z` loads the files in the RubyGem that have been added into git. + spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do + `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + end + spec.bindir = "bin" + spec.executables = ['agenda_pdf'] + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 2.2.22" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" + + spec.add_dependency "prawn", "~> 2.4" +end diff --git a/bin/agenda_pdf b/bin/agenda_pdf new file mode 100755 index 0000000..65a1bb2 --- /dev/null +++ b/bin/agenda_pdf @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require 'agenda_pdf' + +AgendaPdf.execute(ARGV) diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..520cad9 --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "agenda_pdf" + +# 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(__FILE__) 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/agenda_pdf.rb b/lib/agenda_pdf.rb new file mode 100644 index 0000000..0f961b0 --- /dev/null +++ b/lib/agenda_pdf.rb @@ -0,0 +1,18 @@ +require 'date' + +require "agenda_pdf/version" +require "agenda_pdf/options_parser" +require "agenda_pdf/pdf_generator" + +module AgendaPdf + class Error < StandardError; end + + def self.execute(argv) + options = OptionsParser.new + + PdfGenerator.new(options.path) do + text 'hello world' + text argv.to_s + end + end +end diff --git a/lib/agenda_pdf/options_parser.rb b/lib/agenda_pdf/options_parser.rb new file mode 100644 index 0000000..917089c --- /dev/null +++ b/lib/agenda_pdf/options_parser.rb @@ -0,0 +1,46 @@ +require 'optparse' +require 'pathname' + +class OptionsParser + OPTIONS = %i[month verbose path].freeze + + DEFAULT_PATH = ENV['PWD'] + '/agenda.pdf' + + def initialize + @options = {} + + parse_options + end + + def path + @options[:path] || DEFAULT_PATH + end + + def month + @options[:month] || DateTime.now.month + end + + def verbose + @options[:verbose] + end + + private + + def parse_options + OptionParser.new do |opts| + opts.banner = "Usage: agenda_pdf [options]" + + opts.on("-m", "--month", "Generates a pdf for current month") do |v| + @options[:month] = DateTime.parse(v) rescue DateTime.now.month + end + + opts.on("-o", "--path", "The output file path") do |v| + @options[:path] = Pathname.new(v) + end + + opts.on("-v", "--[no-]verbose", "Run verbosely") do |v| + @options[:verbose] = v || false + end + end.parse! + end +end diff --git a/lib/agenda_pdf/pdf_generator.rb b/lib/agenda_pdf/pdf_generator.rb new file mode 100644 index 0000000..04d5edb --- /dev/null +++ b/lib/agenda_pdf/pdf_generator.rb @@ -0,0 +1,21 @@ +require 'prawn' + +class PdfGenerator < Prawn::Document + def initialize(path, &block) + super() + initialize_document + + instance_eval &block + + finalize_document(path) + end + + protected + + def initialize_document; end + + def finalize_document(path) + pp "Rending pdf at #{path}" + render_file(path) + end +end diff --git a/lib/agenda_pdf/version.rb b/lib/agenda_pdf/version.rb new file mode 100644 index 0000000..a13d1c7 --- /dev/null +++ b/lib/agenda_pdf/version.rb @@ -0,0 +1,3 @@ +module AgendaPdf + VERSION = "0.1.0" +end diff --git a/spec/agenda_pdf_spec.rb b/spec/agenda_pdf_spec.rb new file mode 100644 index 0000000..f147472 --- /dev/null +++ b/spec/agenda_pdf_spec.rb @@ -0,0 +1,9 @@ +RSpec.describe AgendaPdf do + it "has a version number" do + expect(AgendaPdf::VERSION).not_to be nil + end + + it "does something useful" do + expect(false).to eq(true) + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..4fee126 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require "bundler/setup" +require "agenda_pdf" + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = ".rspec_status" + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end