boxmodel2 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fb8fe73cc9b8af9ae0513589b10934585ab0b10
-  data.tar.gz: 43172ed9af644a05f60685dbf64c515624309ac1
+  metadata.gz: bf11083777ead95d4c129ca59489216441419c17
+  data.tar.gz: cf2d55bc660b7a492b10c2bc79b6ae8e88cc20d2
 SHA512:
-  metadata.gz: ddf2c4c284d83a506e9d180217d57d7dad3ca764a4c444f5aae86707f4a345ce981e8c53f48963fa5a1c70475257c3fdcfb92420a896a59204b4ba3495bc8e93
-  data.tar.gz: 433191146107baff21ebb1066568ddc88c0c4fad6c5c9b440b1c76a2ff2d48ec72de7f1f2cb84ff1cc3d78b257e8f10e4577c3641d1365c9a6bbfe881b67030a
+  metadata.gz: 829ae0e0b8d843f501e092f4a3f7743e49d905db210bde820ba7da94d447264f987276dbc3cba82677da0f074af1d577768764619f1207505dbb1c2a68ddb982
+  data.tar.gz: 24ea833382a0706bdccb39b6a93430a81ea78dd1edbb4454061d9cc8da19ec7cea1800abb4491e0b216f3ccd0194a0b8991f9abcfcd313b8c946e499d8f7a573

data/.gitignore

@@ -1 +1,2 @@
 .sass-cache
+.DS_Store

data/README.md

@@ -1 +1,113 @@
 # boxmodel2
+`boxmodel2` is css library providing css classes to modify margins, paddings, borders, dimensions and positions without writing css declarations by yourself.
+
+##Instalation
+In your Gemfile include:
+
+    gem 'boxmodel2'
+ and execute:
+
+    $ bundle
+  or install it by:
+  
+    gem install boxmodel2
+    
+##Usage
+###Configuration
+In your CSS manifest add the following lines:
+
+    $bm-min-value: 5;
+    $bm-max-value: 50;
+    $bm-step:      5;
+    @import 'boxmodel2';
+    
+You can also generate classes only for specific values. To do so, define a list of values like this:
+
+    $bm-values: -5,1,2,3,10,40;
+    @import: 'boxmodel2';
+    
+**!important** If `$bm-values` is not `null` variables `$bm-min-value`,  `$bm-max-value` and `$bm-step` are not taken into account.
+
+###Responsive
+`boxmodel2` provides classes you can use in your responsive web design projects. For example class `.m-r-sm-10` added to an element sets margin-right on the element only for small breakpoint.
+By default breakpoints are the same as in Twitter Bootstrap. You can change them using responsive variables.
+
+###Types of classes
+`boxmodel2` generates the following types of classes:
+
+- disabling: `n-p`, `n-b-l`, `m-r-0`;
+- one direction: `m-r--10`, `p-b-5`, `b-t-3`;
+- bi-directional: `m-h-25`, `p-h`;
+- four directional: `m-30`, `b-2`;
+- position: `pb-20`, `pl-10`;
+- demension: `w-30`, `h-15`;
+- responsive: `m-b-xs-30`, `p-t-sm-20`, `b-md-3`, `pl-lg-10`.
+
+###Naming convention
+- n - no (disabling)
+- m - margin
+- p - padding
+- b - border
+- pt - position top
+- pr - position right
+- pb - position bottom
+- pl - position left
+- w - width
+- h - height
+- l - left
+- r - right
+- t - top
+- b - bottom
+- v - vertical
+- h - horizontal
+- xs - extra small
+- sm - small
+- md - medium
+- lg - large
+
+###Examples
+- `n-p` - `padding: 0 !important`
+- `m-t--10` - `margin-top: -10px !important`
+- `p-l-5` - `padding-left: 5px !important`
+- `b-r-2` - `border-width-right: 2px !important`
+- `pb-15` - `bottom: 15px !important`
+- `h-20` - `height: 20px !important`
+- `m-r-sm-30` - `margin-right: 30px !important` only for small screens 
+
+###Variables
+####Generator variables
+Define values for classes generation.
+
+ - `$bm-values` - defines list of values which will be generated; type: `list`; default: `null`
+ - `$bm-min-value` - value from which classes will be generated; type: `number`; default: `5`
+ - `$bm-max-value` - classes generation will stop on this value; type: `number`; default: `30`
+ - `$bm-step` - defines the distance from one class to the other; type: `number`; default: `5`
+ - `$bm-directions` - list of directions which classes will modify; type: `list`; default: `top, right, bottom, left, horizontal, vertical, all`
+
+####Group variables
+Define which group of classes will be generated.
+
+ - `$bm-positions` - type: `boolean`; default: `false`
+ - `$bm-margins`- type: `boolean`; default: `true`
+ - `$bm-borders` - type: `boolean`; default: false
+ - `$bm-paddings` - type: `boolean`; default: `true`
+ - `$bm-dimensions` - type: `boolean`; default: `false`
+ - `$bm-responsive` - type: `boolena`; default: `false`
+
+####Responsive variables
+Define breakpoints for responsive classes. Set `$bm-responsive` to `true` first.
+
+ - `$bm-screen-sm-min` - type: `number`; default: `768px`
+ - `$bm-screen-md-min` - type: `number`; default: `992px`
+ - `$bm-screen-lg-min` - type: `number`; default: `1200px`
+ - `$bm-screen-xs-max` - type: `number`; default: `($bm-screen-sm-min - 1)`
+ - `$bm-screen-sm-max` - type: `number`; default: `($bm-screen-md-min - 1)`
+ - `$bm-screen-md-max` - type: `number`; default: `($bm-screen-lg-min - 1)`
+
+##Contributing
+
+ 1. Fork it.
+ 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 new Pull Request.

data/lib/boxmodel2.rb

@@ -0,0 +1,17 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+unless defined?(Sass)
+  require 'sass'
+end
+
+module Boxmodel2
+  if defined?(Rails) && defined?(Rails::Engine)
+    class Engine < ::Rails::Engine
+      require 'boxmodel2/engine'
+    end
+  else
+    boxmodel2_path = File.expand_path("../../app/assets/stylesheets", __FILE__)
+    ENV["SASS_PATH"] = [ENV["SASS_PATH"], boxmodel2_path].compact.join(File::PATH_SEPARATOR)
+  end
+end

data/lib/boxmodel2/engine.rb

@@ -0,0 +1,5 @@
+module Boxmodel2
+  class Engine < Rails::Engine
+    
+  end
+end

data/lib/boxmodel2/version.rb

@@ -1,3 +1,3 @@
 module Boxmodel2
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxmodel2
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Paweł Rosa
@@ -34,14 +34,16 @@ files:
 - ".gitignore"
 - LICENSE
 - README.md
+- app/assets/stylesheets/boxmodel2.scss
+- app/assets/stylesheets/boxmodel2/_disabling_classes.scss
+- app/assets/stylesheets/boxmodel2/_main_classes.scss
+- app/assets/stylesheets/boxmodel2/_mixins.scss
+- app/assets/stylesheets/boxmodel2/_responsive_classes.scss
+- app/assets/stylesheets/boxmodel2/_vars.scss
 - boxmodel2.gemspec
+- lib/boxmodel2.rb
+- lib/boxmodel2/engine.rb
 - lib/boxmodel2/version.rb
-- vendor/assets/stylesheets/boxmodel2.scss
-- vendor/assets/stylesheets/boxmodel2/_disabling_classes.scss
-- vendor/assets/stylesheets/boxmodel2/_main_classes.scss
-- vendor/assets/stylesheets/boxmodel2/_mixins.scss
-- vendor/assets/stylesheets/boxmodel2/_responsive_classes.scss
-- vendor/assets/stylesheets/boxmodel2/_vars.scss
 homepage: https://github.com/pawelrosa/boxmodel2
 licenses:
 - MIT
@@ -62,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Boxmodel2, css classes modifying box model