monthly_calendar 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23e1dee51357a860d3f5549a3921f478e22cc88e
+  data.tar.gz: 5bab1c5bdad9709f2a2afefe63457682aa72ae5e
+SHA512:
+  metadata.gz: ce183f403982f9fcc0a0196a8368fb5271728f7979bffdc53609501117e5a29d75e0b335eb7b680905b0f77dabbdd9a31dcf5d367046f191993c49fadc5b41f0
+  data.tar.gz: f733c759380f7f566e86fb08c4279a833b6024512d94fca5555c2b1da3f1a5be21be79c1c3c09357e6fe5eba849ac19293c1740c6dd2b4f035c3635a58a8994f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at brandoncc@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brandon Conway
+
+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.

data/README.md

@@ -0,0 +1,69 @@
+# Monthly Calendar Generator
+
+This is a simple library which allows you to create monthly calendars which have
+space to write notes.
+
+It allows you to create PDF files like [this one](samples/calendar.pdf).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monthly_calendar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monthly_calendar
+
+## Standard Usage
+
+```ruby
+require 'monthly_calendar'
+
+calendar = MonthlyCalendar.new(start_date: "January 2018", pages: 2)
+calendar.save("calendar.pdf")
+```
+
+This example is the exact code which was used to generate the sample calendar. The `start_date` value can be any string that `Date#parse` can parse, and defaults to `Date.today` if it isn't provided. `pages` is probably self explanatory, but that is how many months will be generated, starting with `start_date`.
+
+## Advanced Usage
+
+The API offers a `#to_s` method which will return the pdf as a string (using [Prawn::Document#render](http://prawnpdf.org/docs/0.11.1/Prawn/Document.html#method-i-render)).
+
+The API also offers a `#stream` method which will yield the pdf as a string to the block you supply.
+
+```ruby
+require 'monthly_calendar'
+
+calendar = MonthlyCalendar.new(start_date: "January 2018", pages: 2)
+calendar.stream do |calendar_string|
+  puts calendar_string
+end
+
+# => %PDF-1.3
+# => %����
+# => 1 0 obj
+# => << /Creator <feff0050007200610077006e>
+# => /Producer <feff0050007200610077006e>
+# ... 
+```
+
+These methods will allow you to easily do something like render the value as a response from a web server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brandoncc/monthly_calendar. 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).
+
+## Code of Conduct
+
+Everyone interacting in the MonthlyCalendar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/brandoncc/monthly_calendar/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "monthly_calendar"
+
+# 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__)

data/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

data/lib/monthly_calendar.rb

@@ -0,0 +1,105 @@
+require "monthly_calendar/version"
+require "date"
+require "prawn"
+require "prawn/measurement_extensions"
+require_relative "./ui"
+
+class MonthlyCalendar
+  include UI
+
+  attr_reader :pdf
+
+  def initialize(options = {})
+    @start_date = (options[:start_date] && Date.parse(options[:start_date])) ||
+                  Date.today
+    @pages_count = options[:pages] || 1
+
+    @pdf = Prawn::Document.new(page_layout: :landscape, top_margin: 1.in, skip_page_creation: true)
+    create
+  end
+
+  def save(file_name = "calendar.pdf")
+    pdf.render_file File.expand_path(file_name)
+  end
+
+  def stream
+    yield(to_s)
+  end
+
+  def to_s
+    pdf.render
+  end
+
+  private
+
+  def create
+    calendar_contents.each do |(month, weeks)|
+      pdf.start_new_page
+
+      days_in_month = weeks.flatten.compact.max
+      first_day_of_week = weeks[0].index(1)
+
+      weeks_count = ((days_in_month + first_day_of_week) / 7.0).ceil
+
+      pdf.define_grid(rows: weeks_count, columns: 7)
+
+      draw_header(month)
+
+      weeks.each_with_index do |week, week_index|
+        draw_notes(week_index,
+                   find_nil_cells(week),
+                   weeks_count == 6 ? :close : :far)
+
+        week.each_with_index do |day, day_index|
+          draw_day_square(week_index, day_index, day)
+        end
+      end
+
+      # The last thing drawn on each page isn't rendered for some reason so this
+      # just "flushes the queue" (causes the last thing previous to be drawn)
+      pdf.stroke
+    end
+  end
+
+  def calendar_contents
+    months = []
+
+    current_month = @start_date
+
+    @pages_count.times do |page_index|
+      month_text = current_month.strftime("%B %Y")
+
+      days_in_month = Date.new(current_month.year, current_month.month, -1).mday
+      first_day_of_week = Date.new(current_month.year, current_month.month, 1).wday
+
+      weeks_count = ((days_in_month + first_day_of_week) / 7.0).ceil
+
+      days = []
+      days << [] until days.count == weeks_count
+
+      first_day_of_week.times do
+        days[0] << nil
+      end
+
+      days_in_month.times do |day|
+        week = (day + first_day_of_week) / 7
+        days[week] << day + 1
+      end
+
+      days[4] << nil until days[4].count == 7
+
+      unless days[5].nil?
+        days[5] << nil until days[5].count == 7
+      end
+
+      months << [month_text, days]
+      current_month = current_month.next_month
+    end
+
+    months
+  end
+
+  def find_nil_cells(week)
+    { start: week.index(nil), count: week.count(nil) }
+  end
+end

data/lib/monthly_calendar/version.rb

@@ -0,0 +1,3 @@
+class MonthlyCalendar
+  VERSION = "0.2.3"
+end

data/lib/ui.rb

@@ -0,0 +1,67 @@
+module UI
+  private
+
+  def draw_day_square(week_index, day_index, day_text)
+    return unless day_text
+
+    pdf.grid([week_index, day_index], [week_index, day_index]).bounding_box do
+      pdf.stroke_bounds
+
+      pdf.rectangle [0, pdf.bounds.height], 15, 15
+      pdf.text_box day_text.to_s,
+                   at: [0, pdf.bounds.height],
+                   height: 15,
+                   width: 15,
+                   size: 8,
+                   align: :center,
+                   valign: :center
+    end
+  end
+
+
+  def draw_header(month)
+    pdf.rectangle [0, pdf.bounds.height + 0.5.in], pdf.bounds.width, 0.5.in
+    pdf.text_box month,
+                 at: [0, pdf.bounds.height + 0.5.in],
+                 width: pdf.bounds.width,
+                 height: 0.25.in,
+                 align: :center,
+                 valign: :center
+
+    weekdays = %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday]
+    weekdays.each_with_index do |weekday, index|
+      width = pdf.bounds.width / 7
+      left = width * index
+      pdf.rectangle [left, pdf.bounds.height + 0.25.in], width, 0.25.in
+      pdf.text_box weekday,
+                   at: [left, pdf.bounds.height + 0.23.in],
+                   height: 15,
+                   width: width,
+                   size: 8,
+                   align: :center,
+                   valign: :center
+    end
+  end
+
+  def draw_notes(row, nil_cells, lines_distance)
+    return if nil_cells[:count].zero?
+
+    pdf.grid([row, nil_cells[:start]],
+             [row, nil_cells[:start] + nil_cells[:count] - 1]).bounding_box do
+      pdf.stroke_bounds
+
+      pdf.draw_text "Notes",
+                     at: [10, pdf.bounds.height - 12],
+                     size: 5
+
+      starting_line_top = 10
+      line_position_increment = lines_distance == :close ? 17 : 22
+
+      4.times do |i|
+        top = starting_line_top + (i * line_position_increment)
+        pdf.line [10, top],
+                 [pdf.bounds.width - 10, top]
+      end
+    end
+  end
+end

data/monthly_calendar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "monthly_calendar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "monthly_calendar"
+  spec.version       = MonthlyCalendar::VERSION
+  spec.authors       = ["Brandon Conway"]
+  spec.email         = ["brandoncc@gmail.com"]
+
+  spec.summary       = %q{A simple monthly calendar generator with space for notes}
+  spec.homepage      = "http://github.com/brandoncc/monthly_calendar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "prawn", "~> 2.2"
+end