file_to_data_uri 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9ff8efa62708efb190149d2a5e62112b2ec32702beeece7360e5b56dde892e1
+  data.tar.gz: 40bb5ee786facf6af6242114e31922c3eda602d6e2faba9ec7b603b1913dc67b
+SHA512:
+  metadata.gz: 27d6273e888342c32b4f1101ae8e6c07ae11f3ded13d4b8d6c618a168e69a668a64d7db522ffab118d01a06b2ffbbbc2dbec1edef822646ab6e7556281ab4963
+  data.tar.gz: 2bc4c535e9fac1dd1eef05021363b70586689cb19b89594a85e654773e9cb90f967058d6dd3934ac3e8e9a6b4d737501b07cfc82542cdb15b39f9e50a0587bc2

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2025-04-29
+
+### Added
+- Initial implementation of DataURI class
+- Support for converting file paths and file-like objects to data URIs
+- Automatic MIME type detection from file extensions
+- Base64 encoding of file contents

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Raghu Betina and FIRSTDRAFT LLC
+
+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,52 @@
+# FileToDataURI
+
+A Ruby gem that converts files or file-like objects to data URI strings suitable for use in HTML elements.
+
+## Installation
+
+### Gemfile way (preferred)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "file_to_data_uri", "< 1.0.0"
+```
+
+And then, at a command prompt:
+
+```
+bundle install
+```
+
+### Direct way
+
+Or, install it directly with:
+
+```
+gem install file_to_data_uri
+```
+
+## Usage
+
+```ruby
+# With a file path
+data_uri = DataURI.new("path/to/image.jpg")
+data_uri.to_s # => "data:image/jpeg;base64,..."
+
+# With a file-like object (anything that responds to `read`)
+file = File.open("image.png")
+data_uri = DataURI.new(file)
+data_uri.to_s # => "data:image/png;base64,..."
+
+# Direct use in HTML
+# <img src="<%= DataURI.new('logo.png').to_s %>">
+```
+
+### Supported Input Types
+
+- **File paths**: Pass a string with a path to a local image file.
+- **File-like objects**: Pass an object that responds to `read` (like `File.open("image.jpg")` or a Rails uploaded file).
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](LICENSE).

data/file_to_data_uri.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/file_to_data_uri/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "file_to_data_uri"
+  spec.version = DataURI::VERSION
+  spec.authors = ["Raghu Betina"]
+  spec.email = ["raghu@firstdraft.com"]
+  spec.homepage = "https://github.com/firstdraft/file_to_data_uri"
+  spec.summary = "Convert files to data URI strings for use in HTML elements"
+  spec.description = "A Ruby gem that converts files or file-like objects to data URI strings suitable for use in HTML elements like img tags."
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/firstdraft/file_to_data_uri/issues",
+    "changelog_uri" => "https://github.com/firstdraft/file_to_data_uri/blob/main/CHANGELOG.md",
+    "homepage_uri" => "https://github.com/firstdraft/file_to_data_uri",
+    "funding_uri" => "https://github.com/sponsors/firstdraft",
+    "label" => "DataURI",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/firstdraft/file_to_data_uri"
+  }
+
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.add_runtime_dependency "mime-types", "~> 3.0"
+  spec.add_runtime_dependency "base64", "~> 0.1", ">= 0.1.0"
+
+  # All development dependencies are specified in the Gemfile
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*", "CHANGELOG*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/file_to_data_uri/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class DataURI
+  VERSION = "0.0.1"
+end

data/lib/file_to_data_uri.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "base64"
+require "mime/types"
+require_relative "file_to_data_uri/version"
+
+# DataURI class for generating data URIs from files or file-like objects
+class DataURI
+  # Initialize with a file path or file-like object
+  #
+  # @param source [String, #read] File path or file-like object
+  def initialize(source)
+    @source = source
+  end
+
+  # Convert to data URI string
+  #
+  # @return [String] A data URI representation of the file
+  def to_s
+    content = read_content
+    mime_type = determine_mime_type
+    encoded_content = Base64.strict_encode64(content)
+
+    "data:#{mime_type};base64,#{encoded_content}"
+  end
+
+  private
+
+  # Read content from file path or file-like object
+  #
+  # @return [String] Binary content of the file
+  def read_content
+    if @source.respond_to?(:read)
+      # File-like object
+      @source.rewind if @source.respond_to?(:rewind)
+      content = @source.read
+      @source.rewind if @source.respond_to?(:rewind)
+      content
+    else
+      # File path
+      File.binread(@source.to_s)
+    end
+  end
+
+  # Determine the MIME type of the file
+  #
+  # @return [String] MIME type
+  def determine_mime_type
+    if @source.respond_to?(:content_type) && @source.content_type
+      # For Rails uploaded files or similar objects that expose content_type
+      @source.content_type
+    elsif @source.respond_to?(:path) && @source.path
+      # If it's a file object with a path
+      mime_from_path(@source.path)
+    elsif @source.is_a?(String)
+      # If it's a file path as string
+      mime_from_path(@source)
+    else
+      # Default to octet-stream if we can't determine
+      "application/octet-stream"
+    end
+  end
+
+  # Get MIME type from file path
+  #
+  # @param path [String] Path to file
+  # @return [String] MIME type
+  def mime_from_path(path)
+    mime = MIME::Types.type_for(path.to_s).first
+    mime ? mime.to_s : "application/octet-stream"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: file_to_data_uri
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Raghu Betina
+bindir: bin
+cert_chain: []
+date: 2025-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A Ruby gem that converts files or file-like objects to data URI strings
+  suitable for use in HTML elements like img tags.
+email:
+- raghu@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- file_to_data_uri.gemspec
+- lib/file_to_data_uri.rb
+- lib/file_to_data_uri/version.rb
+homepage: https://github.com/firstdraft/file_to_data_uri
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/firstdraft/file_to_data_uri/issues
+  changelog_uri: https://github.com/firstdraft/file_to_data_uri/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/firstdraft/file_to_data_uri
+  funding_uri: https://github.com/sponsors/firstdraft
+  label: DataURI
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/firstdraft/file_to_data_uri
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Convert files to data URI strings for use in HTML elements
+test_files: []