large_text_field 0.3.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479e6ecfbc9e04331d4125757afaa4593bb1a2c5
+  data.tar.gz: 211060974d69f5dcdd47089f9bfe987ef6727397
+SHA512:
+  metadata.gz: 912f8ae3d15de150bb0ba3d6f43838f4d905c1d8171af95991ae07d7aad1c91f6e615bc45416b0f510af3c30b247cfbd2de216037c94a312d4624fdfecb4a0f9
+  data.tar.gz: 3bcc58e429e0614ed9fc5349d5c8aa3d8954e8b49abfa9a3f7b382d642ae74199e6ac4ffed4dca68cdc8d60247fcbf146762e253391a23eb561d52c2d3e63668

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 YOURNAME
+
+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,43 @@
+[![Build Status](https://semaphoreci.com/api/v1/projects/3d5b004f-ce96-4e9a-9591-79ccc52d2b1f/704179/badge.svg)](https://semaphoreci.com/invoca-inc/large_text_field)
+
+# LargeTextField
+
+This gem allows any model to be associated with multiple named text fields.  Each field can hold up to 5 million UTF8
+characters.  Defining new fields on models does not require a database migrations. All text fields are stored in a
+central table that is polymorphically associated with the model, but they act like a column on on the same model.
+
+# How do I use it?
+In you Gemfile add:
+
+```
+  gem large_text_fields
+```
+
+There will be database migration you need to run to define the table, so go ahead and run that...
+
+Any class that wants to define a large text field should include **LargeTextField::Owner**, and then define text fields by calling the **large_text_field** macro.  For example the following is a library class that has text fields for notes and description.
+
+```ruby
+class Library < ActiveRecord::Base
+  include LargeTextField::Owner
+  large_text_field :notes
+  large_text_field :description
+end
+```
+
+That's it!  You can then access notes and description as if they were columns on your class.
+
+The large_text_field macro takes the following options...
+
+ * **maximum:** - The maximum length of a large text field. By default this is 5,000,000 characters, but it can be set to less using this option.
+ * **singularize_errors:** - should validation messages be singularized.
+
+Large text fields default to an empty string.  You cannot store nil in a large text field. 
+
+**Please note:**  Large text field uses the *before_save* callback on the class that is the owner for book-keeping.   Callbacks are great, but if there are multiple handlers for the same callback the order in which they are called is not predictable.  If you want to make changes to large_text_field values in the before_save callback, use the **large_text_field_save** callback instead.  This will be called before the large text field book-keeping so your changes will be saved.  For example, this will call the save_preprocess method on your class before the large text fields are saved...
+
+```ruby
+  set_callback(:large_text_field_save, :before, :save_preprocess)
+```
+
+This project rocks and uses MIT-LICENSE.  You should too.

data/Rakefile

@@ -0,0 +1,52 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LargeTextField'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+namespace :db do
+  task :migrate => [:environment] do |t|
+    system("bundle exec rake db:setup RAILS_ENV='test'")
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: [:test, :rubocop]
+
+desc 'Run rubocop'
+task :rubocop do
+  RuboCop::RakeTask.new
+end

data/db/migrate/20110217210640_add_large_text_fields.rb

@@ -0,0 +1,16 @@
+class AddLargeTextFields < ActiveRecord::Migration
+
+  def self.up
+    create_table :large_text_fields do |t|
+      t.string  :field_name, null: false
+      t.text    :value, char_limit: 5_592_405, limit: 16_777_215
+      t.integer :owner_id, null: false
+      t.string  :owner_type, null: false
+    end
+    add_index :large_text_fields, [:owner_type, :owner_id, :field_name], unique: true, name: 'large_text_field_by_owner_field'
+  end
+
+  def self.down
+    drop_table :large_text_fields
+  end
+end

data/lib/large_text_field.rb

@@ -0,0 +1,12 @@
+require "hobo_support"
+require "protected_attributes"
+
+require "rails"
+
+module LargeTextField
+  MAX_LENGTH = 5_000_000
+end
+
+require "large_text_field/engine"
+require "large_text_field/owner"
+require "large_text_field/named_text_value"

data/lib/large_text_field/engine.rb

@@ -0,0 +1,15 @@
+require 'rails/engine'
+
+module LargeTextField
+  class Engine < ::Rails::Engine
+    isolate_namespace LargeTextField
+
+    paths["app/models"] = "lib/large_text_field"
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s + File::SEPARATOR
+        app.config.paths["db/migrate"].concat config.paths["db/migrate"].expanded
+      end
+    end
+  end
+end

data/lib/large_text_field/named_text_value.rb

@@ -0,0 +1,17 @@
+require "protected_attributes"
+
+module LargeTextField
+  class NamedTextValue < ActiveRecord::Base
+    # Schema
+    #   field_name :string, :limit => 255
+    #   value      :text, :null=>true, :limit => MYSQL_MEDIUM_TEXT_UTF8_LIMIT
+    #
+    # index [ :owner_type, :owner_id, :field_name ], :name => 'large_text_field_by_owner_field', :unique=>true
+
+    attr_accessible :field_name, :value, :owner_type, :owner_id, :owner
+
+    belongs_to :owner, polymorphic: true, inverse_of: :large_text_fields
+
+    self.table_name = "large_text_fields"
+  end
+end

data/lib/large_text_field/owner.rb

@@ -0,0 +1,111 @@
+module LargeTextField
+  module Owner
+    extend ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    included do
+      has_many         :large_text_fields, class_name: "LargeTextField::NamedTextValue", as: :owner, autosave: true, dependent: :destroy, inverse_of: :owner
+      validate         :validate_large_text_fields
+      before_save      :write_large_text_field_changes
+      define_callbacks :large_text_field_save
+
+      class_attribute :large_text_field_options
+      self.large_text_field_options = {}
+    end
+
+    def dup
+      result = super
+
+      result._clear_text_field_on_dup
+
+      large_text_field_options.keys.each { |k| result.set_text_field(k, get_text_field(k)) }
+
+      result
+    end
+
+    def reload
+      super
+      @text_field_hash = nil
+      self
+    end
+
+    def text_field_hash
+      @text_field_hash ||= large_text_fields.build_hash { |text_field| [text_field.field_name, text_field] }
+    end
+
+    def text_field_hash_loaded?
+      defined?(@text_field_hash) && @text_field_hash.present?
+    end
+
+    def get_text_field(field_name)
+      text_field_hash[field_name.to_s]._?.value || ''
+    end
+
+    def set_text_field(original_field_name, original_value)
+      !original_value.nil? or raise "LargeTextField value cannot be set value to nil."
+
+      field_name = original_field_name.to_s
+      value = original_value.is_a?(File) ? original_value.read : original_value.to_s
+      if (field = text_field_hash[field_name])
+        field.value = value
+      else
+        text_field_hash[field_name] = LargeTextField::NamedTextValue.new(owner: self, field_name: field_name, value: value)
+      end
+    end
+
+    def text_field_changed(field_name)
+      text_field_hash_loaded? && @text_field_hash[field_name]._?.changes._?.any?
+    end
+
+    def validate_large_text_fields
+      if text_field_hash_loaded?
+        large_text_field_options.each do |k, options|
+          value = text_field_hash[k]._?.value
+          conjugation = options[:singularize_errors] ? "is" : "are"
+          maximum = options[:maximum] || MAX_LENGTH
+          errors.add k, "#{conjugation} too long (maximum is #{self.class.formatted_integer_value(maximum)} characters)" if value.present? && value.size > maximum
+        end
+      end
+    end
+
+    def write_large_text_field_changes
+      run_callbacks(:large_text_field_save)
+
+      @text_field_hash = text_field_hash.compact.select { |_k, v| v.value.presence }
+      self.large_text_fields = text_field_hash.values.compact
+      true
+    end
+
+    def _clear_text_field_on_dup
+      if instance_variable_defined?(:@text_field_hash)
+        remove_instance_variable(:@text_field_hash)
+      end
+    end
+
+    module ClassMethods
+      def large_text_field(field_name, maximum: nil, singularize_errors: false)
+        field_name = field_name.to_s
+
+        # validate custom maximum
+        if maximum
+          if !maximum.is_a? Integer
+            raise ArgumentError, "maximum must be a number"
+          elsif maximum > MAX_LENGTH
+            raise ArgumentError, "maximum can't be greater than #{formatted_integer_value(MAX_LENGTH)}"
+          elsif maximum < 0
+            raise ArgumentError, "maximum can't be less than 0"
+          end
+        end
+
+        large_text_field_options[field_name] = { maximum: maximum, singularize_errors: singularize_errors }
+        define_method(field_name)              {         get_text_field(field_name)        }
+        define_method("#{field_name}=")        { |value| set_text_field(field_name, value) }
+        define_method("#{field_name}_changed?") { text_field_changed(field_name) }
+      end
+
+      def formatted_integer_value(value)
+        value.to_i.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+      end
+    end
+  end
+end

data/lib/large_text_field/version.rb

@@ -0,0 +1,3 @@
+module LargeTextField
+  VERSION = "0.3.0.pre.1"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.