structify 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ca4a2c78aa18b382aa54c4ba88ef246bd2014f895db59fb877ecfd5cb12edf
-  data.tar.gz: 7cb8abbf4ebc23b68a7c19492d4a5fa648d89bfea4dd49a632418a3a962be1cc
+  metadata.gz: 1542f94c3a228a96c611d5d8c4a9a76ff97b6070321a0b88166d6182a0eec652
+  data.tar.gz: a10e778ed0ea8958b4d111f6b6d49dac5a534ebe05926656760115a60a685856
 SHA512:
-  metadata.gz: 16e43c43971e51405759fd3cdf1cd12759ffef115313c144938d5dea704583e04fff57dfd388682127321b71c527131ed3d6edade964db6bb55e9b1c43900744
-  data.tar.gz: 9de0c840ee85e0ac8722b518125461672006624d70d2d7317e5df9db4832a6bd454e030c2790fab8d6e408d4e694039c4a50f471bf4a45e3a523929d59c7473e
+  metadata.gz: 764c252133923dbd6c340087f58f902ae5753bf2c6d56c65244b81dbbce2fc63da22c0b5b5734049dcc908dbc3c846c8f7f85ee40ff5c8d43ba3f0484a3fe8ec
+  data.tar.gz: c2ba694a9c738fd3067f3cb7c6c4d69fe707664075dc65d1ff7c3ac1d9c29a4b4d166b95767edc6fab202219d042c50e9699d0d266f3489e84ea35efbe182fa7

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2025-03-17
+
+### Added
+
+- Added configuration system with `Structify.configure` method
+- Added ability to configure default container attribute through initializer
+- Changed default container attribute from `:extracted_data` to `:json_attributes`
+
 ## [0.2.0] - 2025-03-12
 
 ### Added

data/Gemfile

@@ -7,8 +7,8 @@ group :development, :test do
   gem "rake", "~> 13.0"
   gem "rspec", "~> 3.12"
   gem "rspec-rails", "~> 6.1"
-  gem "activerecord", "~> 7.1.0"
-  gem "sqlite3", "~> 1.6.0" # For testing with ActiveRecord
+  gem "activerecord", "~> 8"
+  gem 'sqlite3', '~> 2.0', '>= 2.0.2'
   gem "rubocop", "~> 1.21"
   gem "rubocop-rspec", "~> 2.25"
   gem "yard", "~> 0.9"

data/Gemfile.lock

@@ -1,50 +1,48 @@
 PATH
   remote: .
   specs:
-    structify (0.1.0)
-      activesupport (~> 7.1)
+    structify (0.3.0)
+      activesupport (~> 8)
       attr_json (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.5.1)
-      actionview (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
       nokogiri (>= 1.8.5)
-      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.5.1)
-      activesupport (= 7.1.5.1)
+      useragent (~> 0.16)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activemodel (7.1.5.1)
-      activesupport (= 7.1.5.1)
-    activerecord (7.1.5.1)
-      activemodel (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
       timeout (>= 0.4.0)
-    activesupport (7.1.5.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
       logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
       securerandom (>= 0.3)
-      tzinfo (~> 2.0)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
     attr_json (2.5.0)
       activerecord (>= 6.0.0, < 8.1)
@@ -70,15 +68,12 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.9.1)
-    json-schema (4.3.1)
-      addressable (>= 2.8)
     language_server-protocol (3.17.0.4)
     logger (1.6.5)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     minitest (5.25.4)
-    mutex_m (0.3.0)
     nokogiri (1.18.2-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.26.3)
@@ -91,7 +86,6 @@ GEM
     psych (5.2.3)
       date
       stringio
-    public_suffix (6.0.1)
     racc (1.8.1)
     rack (3.1.9)
     rack-session (2.1.0)
@@ -108,10 +102,10 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (7.1.5.1)
-      actionpack (= 7.1.5.1)
-      activesupport (= 7.1.5.1)
-      irb
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
@@ -169,7 +163,7 @@ GEM
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    sqlite3 (1.6.9-x86_64-darwin)
+    sqlite3 (2.2.0-x86_64-darwin)
     stringio (3.1.2)
     thor (1.3.2)
     timeout (0.4.3)
@@ -178,6 +172,8 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    uri (1.0.3)
+    useragent (0.16.11)
     yard (0.9.37)
     zeitwerk (2.7.1)
 
@@ -185,15 +181,14 @@ PLATFORMS
   x86_64-darwin-22
 
 DEPENDENCIES
-  activerecord (~> 7.1.0)
+  activerecord (~> 8)
   debug (>= 1.0.0)
-  json-schema (~> 4.1)
   rake (~> 13.0)
   rspec (~> 3.12)
   rspec-rails (~> 6.1)
   rubocop (~> 1.21)
   rubocop-rspec (~> 2.25)
-  sqlite3 (~> 1.6.0)
+  sqlite3 (~> 2.0, >= 2.0.2)
   structify!
   yard (~> 0.9)
 

data/README.md

@@ -64,9 +64,24 @@ bundle install
 Add a JSON column to store extracted data:
 
 ```ruby
-add_column :articles, :extracted_data, :jsonb  # PostgreSQL
+add_column :articles, :json_attributes, :jsonb  # PostgreSQL (default column name)
 # or
-add_column :articles, :extracted_data, :json   # MySQL
+add_column :articles, :json_attributes, :json   # MySQL (default column name)
+
+# Or if you configure a custom column name:
+add_column :articles, :custom_json_column, :jsonb  # PostgreSQL
+```
+
+## Configuration
+
+Structify can be configured in an initializer:
+
+```ruby
+# config/initializers/structify.rb
+Structify.configure do |config|
+  # Configure the default JSON container attribute (default: :json_attributes)
+  config.default_container_attribute = :custom_json_column
+end
 ```
 
 ## Usage
@@ -192,8 +207,8 @@ article.title        # => "How AI is Changing Healthcare"
 article.category     # => "tech"
 article.topics       # => ["machine learning", "healthcare"]
 
-# All data is in the JSON column
-article.extracted_data  # => The complete JSON
+# All data is in the JSON column (default column name: json_attributes)
+article.json_attributes  # => The complete JSON
 ```
 
 ## Field Types
@@ -324,6 +339,18 @@ article_v3.summary = "Added in v3"
 article_v3.save!  # Record version is automatically updated to 3
 ```
 
+### Accessing the Container Attribute
+
+The JSON container attribute can be accessed directly:
+
+```ruby
+# Using the default container attribute :json_attributes
+article.json_attributes  # => { "title" => "My Title", "version" => 1, ... }
+
+# If you've configured a custom container attribute
+article.custom_json_column  # => { "title" => "My Title", "version" => 1, ... }
+```
+
 
 ## Understanding Structify's Role
 

data/lib/structify/model.rb

@@ -30,17 +30,25 @@ module Structify
       include AttrJson::Record
       class_attribute :schema_builder, instance_writer: false, default: nil
 
-      # Store all extracted data in the extracted_data JSON column
-      attr_json_config(default_container_attribute: :extracted_data)
+      # Use the configured default container attribute
+      attr_json_config(default_container_attribute: Structify.configuration.default_container_attribute)
     end
     
     # Instance methods
     def version_compatible_with?(required_version)
-      record_version = self.extracted_data && self.extracted_data["version"] ? 
-                       self.extracted_data["version"] : 1
+      container_attribute = self.class.attr_json_config.default_container_attribute
+      record_data = self.send(container_attribute) || {}
+      record_version = record_data["version"] || 1
       record_version >= required_version
     end
     
+    # Get the stored version of this record
+    def stored_version
+      container_attribute = self.class.attr_json_config.default_container_attribute
+      record_data = self.send(container_attribute) || {}
+      record_data["version"] || 1
+    end
+    
     # Check if a version is within a given range/array of versions
     # This is used in field accessors to check version compatibility
     #
@@ -286,9 +294,13 @@ module Structify
         
         # Override reader to check version compatibility
         def #{name}
+          # Get the container attribute and data
+          container_attribute = self.class.attr_json_config.default_container_attribute
+          record_data = self.send(container_attribute)
+          
           # Get the version from the record data
-          record_version = self.extracted_data && self.extracted_data["version"] ? 
-                           self.extracted_data["version"] : 1
+          record_version = record_data && record_data["version"] ? 
+                           record_data["version"] : 1
           
           # Check if record version is compatible with field's version range
           field_version_range = #{version_range.inspect}

data/lib/structify/version.rb

@@ -1,3 +1,3 @@
 module Structify
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/structify.rb

@@ -23,6 +23,29 @@ require_relative "structify/model"
 #     end
 #   end
 module Structify
+  # Configuration class for Structify
+  class Configuration
+    # @return [Symbol] The default container attribute for JSON fields
+    attr_accessor :default_container_attribute
+    
+    def initialize
+      @default_container_attribute = :json_attributes
+    end
+  end
+  
+  # @return [Structify::Configuration] The current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  # Configure Structify
+  # @yield [config] The configuration block
+  # @yieldparam config [Structify::Configuration] The configuration object
+  # @return [Structify::Configuration] The updated configuration
+  def self.configure
+    yield(configuration) if block_given?
+    configuration
+  end
   # Base error class for Structify
   class Error < StandardError; end
   

data/structify.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Runtime dependencies
-  spec.add_dependency "activesupport", "~> 7.1"
+  spec.add_dependency "activesupport", "~> 8"
   spec.add_dependency "attr_json", "~> 2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kieran Klaassen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: attr_json
   requirement: !ruby/object:Gem::Requirement