generate-column-widths 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeaae8a97425684bcaaa894651131a3f6fe93d28
+  data.tar.gz: fe60d18972ef4917c5e1a6c539e4b40ab71ddace
+SHA512:
+  metadata.gz: 81218fd6c200cb01573b4e3f797a77d479723b5f0b3e84967ededb6fa450436454c0c5e39c7912be4b8e475025c42775212953ed31189f82b89aa517136a0e0e
+  data.tar.gz: 9c418a888ffca67054c6b950e8fd09746857e527c1f2dadcf4ef118fd2a84d49833c35a7e84de7aeac031ebbc693d7dfd37d4cd3af6e06ccb11e082baf13be2a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in generate-column-widths.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 'Liane Allen'
+
+MIT License
+
+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,193 @@
+# GenerateColumnWidths
+
+This gem allows you to calculate the number of columns to span in a css grid
+when your site may have a variable number of columns of data to display.
+
+It allows you to generate the number of columns you need, and to have them
+automatically be the correct widths to fit your page, based on the data you have
+to display. You don't need to know a priori how many columns your data will
+produce, and you don't need to fill your html with a bunch of centering divs to
+try to make it look ok.
+
+It also allows you to accommodate a situation when the columns being generated
+need to fit alongside columns that are already on the page.
+
+You use the generated variable to create columns automatically in your views.
+For example, in this snippet, which generates a 4 column layout for screen sizes
+small and above (a Bootstrap concept):
+
+    <% @your_collection.each do |item| %>
+      <div class="col-sm-3">
+      ...
+    <% end %>
+
+The variable generated by the gem replaces the "3" in the col-sm-3 with the
+variable generated by the gem's method. As your view iterates through the
+items in the collection and renders them in the view, it will generate only the
+number of columns you need for the data you have. The columns will
+automatically be the right width to accommodate your data. If you have fewer
+than expected, your columns won't all be clumped together to one side- and you
+can accomplish that without having to add a bunch of centering divs to wrap the
+content.
+
+This doc is largely implementation oriented. If you need a bit more of a plain
+English description of what it does, check out my blog post:
+[lianeallen.com/home/2014/09/module-to-auto-generate-column-widths-in-a-grid-system/](http://www.lianeallen.com/home/2014/09/module-to-auto-generate-column-widths-in-a-grid-system/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'generate-column-widths'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install generate-column-widths
+
+## Usage
+Once it's installed, it's easy to use:
+
+###1. Include the Module in the Model that Needs It
+
+In the model whose views will need auto-generated column widths:
+
+    include GenerateColumnWidths
+
+#### Example
+Since I'm using this for views that contain lists of project categories, I put
+it in my Category model, category.rb:
+
+    class Category < ActiveRecord::Base
+      include GenerateColumnWidths
+      ...
+    end
+
+###2. Determine How Many Columns are in Your Data
+From the controller where the view is generated, calculate the number of columns
+you need.
+
+####Example:
+In my case, I needed to get a count of the number of meta-category headings I'd
+have in my view by finding out how many of those meta-categories contained any
+associated projects:
+
+    @category_types = # code to find which meta categories contain projects
+    @category_types_count = category_types.count
+
+###3. Call the Generator
+In your controller, call the generator.
+
+Simply call the generate_widths method with your new variable. Call it via the
+model into which you placed it. In my case, that's Category.
+
+This is the code in my categories_controller.
+
+    @column_width = Category.new.generate_widths(
+      @category_types_count
+    )
+
+I use @column_width in the Bootstrap div in my categories index view (see below).
+
+###5. Use it in Your View
+Replace the number in the div that defines the column span in your view.
+Here's what it looks like in a Bootstrap column div for small views and higher:
+
+    <% @category_types.each do |type| %>
+      <div class="col-sm-<%= @column_width %>">
+      ...
+    <% end %>
+
+Be sure to put the div inside the iterator, or you're going to end up with just one
+narrow column.
+
+###You Can Change the Defaults
+The generator has several defaults built in. It assumes you want a maximum of 4
+columns in your view, using a 12 column Bootstrap3 grid. You can change the
+defaults by specifying a different value for any or all of the optional variables.
+
+You need only include those options you want to change. Any option you don't
+include will automatically use the default.
+
+####Option: total_grid_columns
+The number of columns in your grid system. Bootstrap3 uses 12, others may use 9
+or some other number.
+
+Default:
+
+    total_grid_columns: 12
+
+####Option: existing_columns
+The number of columns already in the view, that will share a row with your new
+columns. In the vast majority of cases, you won't need to change this, but it's
+here in case you do.
+
+Default:
+
+    existing_columns: 0
+
+####Option: min_column_span
+The minimum span you want to use. This is one of those counter-intuitive things
+in Bootstrap. It's not the number of columns you want, it's:
+
+ How many of the 12 columns in the grid do you want this column to span?
+
+So, you divide the total number of columns in the grid by this number to get
+the number of columns you're trying to span.
+
+The result is how many columns you'll end up with in your row, before Bootstrap
+wraps to a new line to display the next set of columns.
+
+The default is to span 3 columns, at a minimum, which means (12 / 3 = 4) you'll
+get a maximum of 4 columns in the view.
+
+Default:
+
+    min_column_span: 3
+
+Unless you're fond of seeing divide by zero errors, don't set this to zero.
+
+####Option: max_column_span
+This is the maximum number of columns you want to span. It's the opposite of the
+above. The default is 12, so divide 12/12, and you get ... 1. That's the minimum
+number of columns that will be shown.
+
+Default:
+
+    max_column_span: 12
+
+Unless you're fond of seeing divide by zero errors, don't set this to zero.
+
+####Example 1
+On one page, I need to accomodate an extra column of data that's generated
+elsewhere. So my categories columns will appear in the same row as an extra
+column. To deal with this, I can call:
+
+    @column_width = Category.new.generate_widths(
+      @category_types_count,
+      existing_columns: 1
+    )
+
+####Example 2
+Alternatively, if I were using a 9 grid, instead of a 12 grid, I could specify:
+
+    @column_width = Category.new.generate_widths(
+      @category_types_count,
+      total_grid_columns: 9,
+      max_column_span: 9
+    )
+
+In this case, the default min_column_span (3) would be divided into 9, giving me a
+maximum of 3 columns in my view before Bootstrap wraps to a new line for
+additional columns.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/generate-column-widths/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/generate-column-widths.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generate-column-widths/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "generate-column-widths"
+  spec.version       = GenerateColumnWidths::VERSION
+  spec.authors       = ["'Liane Allen'"]
+  spec.email         = ["'github@lianeallen.com'"]
+  spec.summary       = %q{Generate the span value to use with a css grid system.}
+  spec.description   = %q{Automatically generates the span value to use when
+                          your view may have a variable number of columns,
+                          and you're using a css grid system.}
+  spec.homepage      = "http://github.com/liantics/generate-column-widths"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock

data/lib/generate-column-widths.rb

@@ -0,0 +1,20 @@
+require "generate-column-widths/version"
+
+module GenerateColumnWidths
+  def generate_widths(new_columns,
+                      total_grid_columns: 12,
+                      existing_columns: 0,
+                      min_column_span: 3,
+                      max_column_span: 12)
+    columns_in_row = new_columns + existing_columns
+    span = (total_grid_columns / columns_in_row).floor
+
+    if span < min_column_span
+      span = min_column_span
+    elsif span > max_column_span
+      span = max_column_span
+    end
+
+    span
+  end
+end

data/lib/generate-column-widths/version.rb

@@ -0,0 +1,3 @@
+module GenerateColumnWidths
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: generate-column-widths
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- "'Liane Allen'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Automatically generates the span value to use when
+                            your view may have a variable number of columns,
+                            and you're using a css grid system.
+email:
+- "'github@lianeallen.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- generate-column-widths.gemspec
+- gitignore
+- lib/generate-column-widths.rb
+- lib/generate-column-widths/version.rb
+homepage: http://github.com/liantics/generate-column-widths
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate the span value to use with a css grid system.
+test_files: []