ruby-clip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38d04be6e9a54a1bd07fef270d5040d36bae39572be238876fa64baa089dae4a
+  data.tar.gz: b4a4f2532d37c2ee5db743af02d7429a2005e0bb74ed1c234d6578a84d92e4b6
+SHA512:
+  metadata.gz: 7f922425c94fafe8ccf6178376ca33364ab0f99a86a096e8c83d37f399b372cc0825c0c084c6c2ee63bbab3039b93ea3f91db8a4b733518fe80a52d1c7825b5a
+  data.tar.gz: 9b9a06d319e20734c9412521b3b26148376c93147c1907c52a82d3784ed116adfaae09ab9092cc5e5ca43b6a2e0095b2dc968c66b7acf069b0bac5f1b84a5abd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-10
+
+- Initial release, Canvas Preview export only

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Julien 'Lta' BALLET
+
+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,61 @@
+# Ruby::Clip
+
+A miminal parser for Clip Studio Paint file. Currently this lib can only export
+the Canvas previews out of the file.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+``` ruby
+require 'clip'
+
+file = Clip::File.open('/path/to/file.clip')
+preview = file.previews.first
+
+# Get info about the canvas preview
+preview.width    # => 800
+preview.height   # => 60000
+
+# Access the preview image content
+preview.image    # => "PNG..."
+
+# Save the preview to a file
+preview.image_save('/tmp/my_clip_preview.png')
+
+# Save the preview to a temporary file
+tempfile = preview.image_tempfile # => #<File:/tmp/ruby-clip--20241211-276516-hunc5h.png>
+tempfile.close
+
+# Close the file, coz' you're so well-behaved
+file.close
+```
+
+## 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 the created tag, 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/flagcatstudio/ruby-clip.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/clip/canvas_preview.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Clip
+  class CanvasPreview
+    attr_reader :file, :row
+
+    def initialize(file, row)
+      @file = file
+      @row = row
+    end
+
+    def inspect
+      "#{self.class.name}: #{@row}"
+    end
+
+    def main_id
+      row[:MainId]
+    end
+
+    def canvas_id
+      row[:CanvasId]
+    end
+
+    def width
+      row[:ImageWidth]
+    end
+
+    def height
+      row[:ImageHeigth]
+    end
+
+    def image_type
+      # NOTE: So far I've only encountered ImageType == 1, which I assume means
+      # png. but we can't know for sure :shrug:
+      row[:ImageType]
+    end
+
+    def image
+      row[:ImageData]
+    end
+
+    def image_tempfile
+      file = Tempfile.new(['ruby-clip--', '.png'])
+      file.write image
+      file.seek 0
+      file
+    end
+
+    def image_save(path)
+      File.open(path, 'wb') do |file|
+        file.write image
+      end
+    end
+  end
+end

data/lib/clip/file.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'sqlite3'
+
+require_relative './canvas_preview'
+
+module Clip
+  class File
+    MAGIC = 'CSFCHUNK'
+    SQLITE_MAGIC = 'SQLite format 3'
+    FOOTER_MARKER = 'CHNKFoot'
+
+    attr_reader :path
+
+    def self.open(*, **)
+      new(*, **)
+    end
+
+    def initialize(path)
+      @path = path
+
+      raise InvalidClipFile, 'Not a CSP .clip' unless magic_present?
+      raise InvalidClipFile, 'No database found in .clip' unless sqlite_present?
+    end
+
+    def file
+      @file ||= ::File.open(path, 'rb')
+    end
+
+    def raw_content
+      @raw_content ||= file.read
+    end
+
+    def magic_present?
+      file.pread(MAGIC.length, 0) == MAGIC
+    end
+
+    def sqlite_present?
+      !sqlite_index.nil?
+    end
+
+    def sqlite_content
+      @sqlite_content ||=
+        begin
+          len = footer_index - sqlite_index
+          raw_content.byteslice(sqlite_index, len)
+        end
+    end
+
+    def sqlite_file
+      @sqlite_file ||=
+        begin
+          file = Tempfile.new("ruby-clip-#{basename}--")
+          file.write(sqlite_content)
+          file.seek(0)
+          file
+        end
+    end
+
+    def sqlite
+      @sqlite ||= SQLite3::Database.open(sqlite_file.path)
+    end
+
+    def close
+      if defined? :@sqlite && @sqlite
+        @sqlite.close
+        @sqlite = nil
+      end
+
+      if defined? :@sqlite_file && @sqlite_file
+        @sqlite_file.close
+        @sqlite_file.unlink
+        @sqlite_file = nil
+      end
+    end
+
+    def canvas_previews
+      rows = sqlite_execute_as_hash <<-SQL
+        SELECT * FROM CanvasPreview;
+      SQL
+      rows.map { |row| CanvasPreview.new(self, row) }
+    end
+
+
+    protected
+
+    def basename
+      ::File.basename(path)
+    end
+
+    def sqlite_index
+      raw_content.index SQLITE_MAGIC
+    end
+
+    def footer_index
+      raw_content.rindex FOOTER_MARKER || raw_content.length
+    end
+
+    def sqlite_execute_as_hash(query)
+      rows = sqlite.execute2(query)
+      headers = rows.shift.map(&:to_sym)
+
+      rows.map do |row|
+        h = {}
+        headers.each_with_index { |header, index|  h[header] = row[index] }
+        h
+      end
+    end
+  end
+end

data/lib/clip/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clip
+  VERSION = "0.1.0"
+end

data/lib/clip.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "clip/version"
+
+require_relative "clip/file"
+
+module Clip
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class InvalidClipFile < Error; end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: ruby-clip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien 'Lta' BALLET
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description:
+email:
+- lta@flagcat.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/clip.rb
+- lib/clip/canvas_preview.rb
+- lib/clip/file.rb
+- lib/clip/version.rb
+homepage: https://github.com/FlagCatStudio/ruby-clip
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FlagCatStudio/ruby-clip
+  source_code_uri: https://github.com/FlagCatStudio/ruby-clip
+  changelog_uri: https://github.com/FlagCatStudio/ruby-clip/blob/main/CHANGELOG.md
+  Copyrights: Flagcat SAS
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A minimal parser for Clip Studio Paint files
+test_files: []