rapicco 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f75b483f11ab21e49743716cf5c8e41d66d906e59a06a6cd3d91e7a68951f5da
-  data.tar.gz: dfdd6c4403ca2cd7d652b1a4bdf13512919f4142c8e5836279142462583734fa
+  metadata.gz: c4e290b0008061b7bba5f6e6bcb36dc1682739d58ee216b3204e3e0f207b48ab
+  data.tar.gz: e1a1d04f0ad5d35ec559c10a42b44237bd5159b25a865c4645810b22d756177d
 SHA512:
-  metadata.gz: 995b0755fb6634c30e0183b51cd7638da3fb1b6ba0f32eb56ddd4df030710fcae9c8da188a4ce698fcd7c80b10657edd6819d3cfd4e84ed093345f1f05a8885f
-  data.tar.gz: f277684e2d09d4446793ccbaffee37175cd2109838006a1d5d95d4c3a41ba510ff802101303975a9307a14208f19c30b6772534af3663639f422c8c5433c3242
+  metadata.gz: 359e7e4ad563e7992cc1fbf65d3e294c032255880d1bc1cd342f024360381da2aa6a96259f86ae5d0e192db5cf98d7964fee9b031da80915640dc0890df403b5
+  data.tar.gz: 937be7c318d35440cfe516104a5249c43393f6c2ff975968cf7820371787dabbc7c7cd7dc92ac8e34c4c6e6a60178c7883f2d5ed2c62d62ee1b4b6441d0fa194

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# CHANGELOG
+
+## [0.2.0] - 2025-11-11
+
+### Added
+- New `rapicco new` command to create presentation project templates
+- PDF up-to-date check: Skip PDF generation if both slide.md and config.yaml are older than the target PDF
+- Configuration validation for gem creation with detailed error messages
+- README.md validation to ensure proper documentation before gem creation
+- Support for `--cols` and `--rows` options in PDF generation
+- New constants file (lib/rapicco/constants.rb) for centralized configuration
+- GitHub Actions CI workflow for automated testing
+- Comprehensive test suite using test-unit framework
+- Rakefile for running tests
+
+### Changed
+- Renamed configuration file from `config.yml` to `config.yaml`
+- Switched test framework from RSpec to test-unit
+- Required Ruby version updated from >= 3.0.0 to >= 3.2.0
+- Enhanced README.md with detailed usage instructions and examples
+- Improved error handling in PDF PageCapturer with better timeout management
+- Updated LICENSE copyright owner from PicoRuby to HASUMI Hitoshi
+- Enabled `gem push` command for publishing to RubyGems.org
+
+### Removed
+- Removed `ffi` dependency from gemspec and Gemfile
+- Removed unused exported_pages directory
+
+## [0.1.0] - 2025-11-10
+- The first release

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 PicoRuby
+Copyright (c) 2025 HASUMI Hitoshi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,7 @@
 # Rapicco
 
+[![Test](https://github.com/picoruby/rapicco/actions/workflows/test.yml/badge.svg)](https://github.com/picoruby/rapicco/actions/workflows/test.yml)
+
 A wrapper tool of PicoRuby Rapicco terminal-based presentation.
 
 ## Overview
@@ -9,9 +11,10 @@ It also converts Rapicco presentations  into PDF documents capturing the ANSI te
 
 ## Requirements
 
-- Ruby 3.0 or later
+- Ruby (you can see supported versions in [rapicco.gemspec](rapicco.gemspec))
 - Cairo graphics library
 - PicoRuby with Rapicco installed
+  - `export PICORUBY_PATH=path/to/picoruby` needs to be set
 
 ## Installation
 
@@ -19,13 +22,71 @@ It also converts Rapicco presentations  into PDF documents capturing the ANSI te
 gem install rapicco
 ```
 
-Or add to your Gemfile:
+## Usage
+
+### Create a presentation project (recommended)
 
-```ruby
-gem 'rapicco'
+1. Create a new presentation project along with `mkdir`:
+
+```bash
+rapicco new my-presentation
+cd my-presentation
 ```
 
-## Usage
+Or in existing directory,
+
+```bash
+cd my-presentation
+rapicco new .
+```
+
+> [!WARNING]
+> The above command will override existing files.
+
+This generates:
+- `Gemfile` with rapicco gem
+- `Rakefile` with presentation tasks
+- `slide.md` template
+- `config.yaml` configuration
+- `README.md` template
+- `.gitignore`
+
+2. Install dependencies:
+
+```bash
+bundle install
+```
+
+3. Use rake tasks to manage your presentation:
+
+```bash
+bundle exec rake -T
+```
+
+Available tasks:
+```
+rake gem      # Create gem package
+rake pdf      # Generate PDF
+rake publish  # Publish gem to RubyGems.org
+rake run      # Run presentation
+```
+
+**Show presentation:**
+```bash
+bundle exec rake run
+```
+
+**Generate PDF:**
+```bash
+bundle exec rake pdf
+```
+
+**Create gem package:**
+```bash
+bundle exec rake gem
+```
+
+### Using CLI directly
 
 **Show presentation:**
 ```bash

data/lib/rapicco/constants.rb

@@ -0,0 +1,5 @@
+module Rapicco
+  REQUIRED_RUBY_VERSION = '>= 3.2.0'
+  PDF_DEFAULT_TITLE = 'Slide Title'
+  PDF_DEFAULT_DESCRIPTION = 'Your slide description here.'
+end

data/lib/rapicco/installer.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'yaml'
+require_relative 'constants'
 
 module Rapicco
   class Installer
@@ -69,18 +70,18 @@ module Rapicco
         ---
         duration: 300
         sprite: hasumikin
-        title_font: terminus_8x16
-        font: terminus_6x12
+        title_font: shinonome_go16
+        font: shinonome_go12
         bold_color: red
         align: center
-        line_margin: 1
+        line_margin: 3
         code_indent: 2
         ---
 
-        # Title Slide
+        # #{Rapicco::PDF_DEFAULT_TITLE}
         {align=center, scale=2}
 
-        Your presentation title
+        #{Rapicco::PDF_DEFAULT_DESCRIPTION}
 
         # Introduction
 
@@ -100,6 +101,8 @@ module Rapicco
       config = {
         'id' => nil,
         'base_name' => nil,
+        'description' => nil,
+        'presentation_date' => nil,
         'tags' => [],
         'version' => nil,
         'licenses' => [],
@@ -107,10 +110,14 @@ module Rapicco
           'name' => nil,
           'email' => nil,
           'rubygems_user' => nil
+        },
+        'pdf' => {
+          'cols' => 350,
+          'rows' => 196
         }
       }
 
-      File.write(File.join(target_dir, 'config.yml'), YAML.dump(config))
+      File.write(File.join(target_dir, 'config.yaml'), YAML.dump(config))
     end
 
     def create_readme(target_dir)
@@ -119,13 +126,11 @@ module Rapicco
 
         Your slide description here.
 
-        ## Author
+        ## Authors
 
         Your Name
 
         ## License
-
-        CC BY-SA 4.0
       README
 
       File.write(File.join(target_dir, 'README.md'), content)

data/lib/rapicco/pdf/page_capturer.rb

@@ -76,11 +76,19 @@ module Rapicco
         begin
           Timeout.timeout(timeout) do
             loop do
-              output << stdout.read_nonblock(10000)
+              begin
+                chunk = stdout.read_nonblock(10000)
+                output << chunk
+              rescue IO::WaitReadable
+                if IO.select([stdout], nil, nil, 1.0)
+                  retry
+                else
+                  break
+                end
+              end
             end
           end
         rescue Timeout::Error
-        rescue IO::WaitReadable
         rescue EOFError, Errno::EIO
           return nil
         end

data/lib/rapicco/slide_gem_builder.rb

@@ -1,15 +1,76 @@
 require 'fileutils'
 require 'rubygems/package'
+require_relative 'constants'
 
 module Rapicco
   class SlideGemBuilder
+    def self.validate_config(config)
+      errors = []
+
+      # Required fields
+      errors << "config.yaml: 'id' is required" if config['id'].nil? || config['id'].empty?
+      errors << "config.yaml: 'base_name' is required" if config['base_name'].nil? || config['base_name'].empty?
+      errors << "config.yaml: 'version' is required" if config['version'].nil? || config['version'].empty?
+      errors << "config.yaml: 'description' is required" if config['description'].nil? || config['description'].empty?
+      errors << "config.yaml: 'presentation_date' is required" if config['presentation_date'].nil? || config['presentation_date'].empty?
+
+      # Licenses
+      if config['licenses'].nil? || config['licenses'].empty?
+        errors << "config.yaml: 'licenses' must have at least one license"
+      end
+
+      # Author fields
+      if config['author'].nil?
+        errors << "config.yaml: 'author' section is required"
+      else
+        errors << "config.yaml: 'author.name' is required" if config['author']['name'].nil? || config['author']['name'].empty?
+        errors << "config.yaml: 'author.rubygems_user' is required" if config['author']['rubygems_user'].nil? || config['author']['rubygems_user'].empty?
+      end
+
+      unless errors.empty?
+        raise <<~ERROR
+          Configuration validation failed:
+
+          #{errors.map { |e| "  - #{e}" }.join("\n")}
+
+          Please edit config.yaml and fill in all required fields.
+        ERROR
+      end
+    end
+
+    # raise error if README.md is missing or malformed
+    # checklist:
+    #   - README.md exists
+    #   - README.md has a title (first line starts with '# ')
+    #     - The title is not identical to Rapicco::PDF_DEFAULT_TITLE
+    def self.validate_readme
+      unless File.file?('README.md')
+        raise "README.md is missing. Please provide a README.md file."
+      end
+      File.open('README.md', 'r') do |file|
+        lines = file.readlines.map(&:chomp)
+        if lines.empty?
+          raise "README.md is empty. Please provide a valid README.md file."
+        end
+        title_line = lines.find { |line| line.start_with?('# ') }
+        if title_line.nil?
+          raise "README.md is missing a title. The first line should start with '# '."
+        end
+        title = title_line.sub('# ', '').strip
+        if title.empty?
+          raise "README.md has an empty title. Please provide a valid title."
+        end
+        if title == Rapicco::PDF_DEFAULT_TITLE
+          raise "README.md title is the default placeholder. Please provide a meaningful title."
+        end
+      end
+    end
+
     def initialize(config)
       @config = config
     end
 
     def build
-      validate_config
-
       FileUtils.mkdir_p('pkg')
 
       spec = build_gemspec
@@ -27,54 +88,23 @@ module Rapicco
 
     private
 
-    def validate_config
-      errors = []
-
-      # Required fields
-      errors << "config.yml: 'id' is required" if @config['id'].nil? || @config['id'].empty?
-      errors << "config.yml: 'base_name' is required" if @config['base_name'].nil? || @config['base_name'].empty?
-      errors << "config.yml: 'version' is required" if @config['version'].nil? || @config['version'].empty?
-
-      # Licenses
-      if @config['licenses'].nil? || @config['licenses'].empty?
-        errors << "config.yml: 'licenses' must have at least one license"
-      end
-
-      # Author fields
-      if @config['author'].nil?
-        errors << "config.yml: 'author' section is required"
-      else
-        errors << "config.yml: 'author.name' is required" if @config['author']['name'].nil? || @config['author']['name'].empty?
-        errors << "config.yml: 'author.email' is required" if @config['author']['email'].nil? || @config['author']['email'].empty?
-        errors << "config.yml: 'author.rubygems_user' is required" if @config['author']['rubygems_user'].nil? || @config['author']['rubygems_user'].empty?
-      end
-
-      unless errors.empty?
-        raise <<~ERROR
-          Configuration validation failed:
-
-          #{errors.map { |e| "  - #{e}" }.join("\n")}
-
-          Please edit config.yml and fill in all required fields.
-        ERROR
-      end
-    end
-
     def build_gemspec
       config = @config
       slide_file = find_slide_file
       pdf_file = "pdf/#{config['id']}-#{config['base_name']}.pdf"
 
       Gem::Specification.new do |spec|
+        spec.required_ruby_version = Rapicco::REQUIRED_RUBY_VERSION
+
         spec.name = "rabbit-slide-#{config['author']['rubygems_user']}-#{config['id']}"
         spec.version = config['version']
         spec.authors = [config['author']['name']]
         spec.email = [config['author']['email']]
 
         spec.summary = "Rapicco slide: #{config['id']}"
-        spec.description = read_description
+        spec.description = "#{config['description']}"
         spec.homepage = "https://slide.rabbit-shocker.org/authors/#{config['author']['rubygems_user']}/#{config['id']}/"
-        spec.license = config['licenses'].first
+        spec.licenses = config['licenses']
 
         spec.metadata = {
           "rapicco.slide.id" => config['id'],
@@ -85,7 +115,7 @@ module Rapicco
         spec.files = [
           slide_file,
           pdf_file,
-          'config.yml',
+          'config.yaml',
           'Rakefile',
           'README.md'
         ].select { |f| File.exist?(f) }
@@ -103,30 +133,5 @@ module Rapicco
       end
     end
 
-    def read_description
-      return @config['id'] unless File.exist?('README.md')
-
-      readme = File.read('README.md')
-      # Extract first paragraph after title
-      lines = readme.lines
-      description_lines = []
-      found_title = false
-
-      lines.each do |line|
-        if line.start_with?('#')
-          found_title = true
-          next
-        end
-
-        next if line.strip.empty? && !found_title
-
-        if found_title
-          break if line.strip.empty? && !description_lines.empty?
-          description_lines << line.strip
-        end
-      end
-
-      description_lines.join(' ').strip[0..200]
-    end
   end
 end

data/lib/rapicco/task/slide.rb

@@ -15,10 +15,10 @@ module Rapicco
       private
 
       def load_config
-        unless File.exist?('config.yml')
-          raise "config.yml not found. Please create it first."
+        unless File.exist?('config.yaml')
+          raise "config.yaml not found. Please create it first."
         end
-        YAML.load_file('config.yml')
+        YAML.load_file('config.yaml')
       end
 
       def define_tasks
@@ -37,12 +37,35 @@ module Rapicco
           pdf_name = "#{@config['id']}-#{@config['base_name']}.pdf"
           pdf_path = File.join(pdf_dir, pdf_name)
 
-          sh "rapicco -p -o #{pdf_path} #{slide_file}"
+          # Check if PDF is up to date
+          if File.exist?(pdf_path)
+            pdf_mtime = File.mtime(pdf_path)
+            slide_mtime = File.mtime(slide_file)
+            config_mtime = File.mtime('config.yaml')
+
+            if slide_mtime < pdf_mtime && config_mtime < pdf_mtime
+              puts "PDF is up to date: #{pdf_path}"
+              next
+            end
+          end
+
+          cols = @config.dig('pdf', 'cols') || 350
+          rows = @config.dig('pdf', 'rows') || 196
+
+          sh "rapicco -p -o #{pdf_path} #{slide_file} --cols #{cols} --rows #{rows}"
           puts "PDF created: #{pdf_path}"
         end
 
+        task :validate_config do
+          Rapicco::SlideGemBuilder.validate_config(@config)
+        end
+
+        task :validate_readme do
+          Rapicco::SlideGemBuilder.validate_readme
+        end
+
         desc "Create gem package"
-        task gem: :pdf do
+        task gem: [:validate_config, :validate_readme, :pdf] do
           builder = Rapicco::SlideGemBuilder.new(@config)
           gem_file = builder.build
           puts "Gem created: #{gem_file}"
@@ -50,9 +73,8 @@ module Rapicco
 
         desc "Publish gem to RubyGems.org"
         task publish: :gem do
-          puts "Publishing gem is currently disabled."
-          #gem_file = gem_filename
-          #sh "gem push #{gem_file}"
+          gem_file = gem_filename
+          sh "gem push #{gem_file}"
         end
       end
 

data/lib/rapicco/version.rb

@@ -1,3 +1,3 @@
 module Rapicco
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapicco
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HASUMI Hitoshi
@@ -23,20 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,10 +44,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/rapicco
 - lib/rapicco.rb
+- lib/rapicco/constants.rb
 - lib/rapicco/installer.rb
 - lib/rapicco/pdf.rb
 - lib/rapicco/pdf/ansi_parser.rb
@@ -82,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="