daru-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f80dd124b93d1d6c8b4d22e41c15f9576ca0f74
+  data.tar.gz: 7d2d452ab2a3adeb98a89e4426b4e039c3fcd437
+SHA512:
+  metadata.gz: 92089bbdd71659503e8bee0c7403e93588b8f68c8a7690bbde4c80ad37642eb1f156a6fa01d83ae2b7e41710eb29d4b4c872842f981e16512c5412b24ab092fa
+  data.tar.gz: fb23580ad917e98ae5ce36039f3be59fdbd5e54acd3319a19144ad4528d45e1f586dba07ebf0bff83380d65f69d04eff94e7c0362c05edb2bc8d80389e6624f0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.lock
+*.ruby-version

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--warnings

data/.rubocop.yml

@@ -0,0 +1,122 @@
+AllCops:
+  Include:
+    - 'lib/**/*'
+  Exclude:
+    # - 'daru-view.gemspec'
+    - 'Rakefile'
+    - 'Gemfile'
+    - 'Guardfile'
+    - '**/*.erb'
+    - '**/*.js'
+    - 'spec/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+    - 'benchmarks/*'
+    - 'profile/*'
+    - 'bin/*'
+    - 'daru-view.gemspec'
+    - '**/*.rake'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.0
+
+# Preferred codebase style ---------------------------------------------
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 200
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Layout/SpaceAfterComma:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+# See https://github.com/bbatsov/rubocop/issues/4429
+Style/YodaCondition:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'
+
+# Neither of prefered styles are good enough :(
+Style/BlockDelimiters:
+  Enabled: false
+
+# Current preferred metrics --------------------------------------------
+# Better values are encouraged, but not required.
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# TODO -----------------------------------------------------------------
+
+Style/Documentation:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+# Must be removed in future
+
+Lint/DuplicateMethods:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_group "lib", "lib"
+end

data/.travis.yml

@@ -0,0 +1,18 @@
+language:
+  ruby
+
+rvm:
+  - '2.0'
+  - '2.1'
+  - '2.2'
+  - '2.3.0'
+  - '2.4.0'
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+
+install:
+  - gem install bundler
+  - gem install rainbow -v '2.2.1'
+  - bundle install

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## 0.1.0 (2017-09-20)
+
+**Features:**
+
+- Generate Plot using [Nyaplot](https://github.com/SciRuby/nyaplot),
+[google_visualr](https://github.com/winston/google_visualr/),
+[lazy_high_charts](https://github.com/michelson/lazy_high_charts) gem with more features.
+
+- Generate Tables using [Google Charts DataTable](https://developers.google.com/chart/interactive/docs/gallery/table) and [daru-data_tables](https://github.com/Shekharrajak/daru-data_tables) with features like pagination, sorting by column, option to choose number of rows to be displayed.
+
+- Plotting can be done in IRuby notebook as well as any ruby web application
+framework.
+
+- Data can be in Daru::DataFrame, Daru::Vector, array of array data or
+according to the formate described in [Google Charts tool](https://developers.google.com/chart/interactive/docs/gallery), [Highcharts](https://www.highcharts.com/demo).
+
+- User can use all the features already present in google_visualr,
+lazy_high_charts, nayplot by accessing the respective object using
+`#chart` and tables using `#table`.
+
+- The article written about initial features briefly : https://github.com/shekharrajak/daru-view/wiki/All-about-daru-view

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shekharstudy@ymail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing guide
+
+## Installing daru development dependencies
+
+Install [Daru](https://github.com/SciRuby/daru) dependencies : [installing-daru-development-dependencies](https://github.com/SciRuby/daru/blob/master/CONTRIBUTING.md#installing-daru-development-dependencies)
+
+
+Then install remaining dependencies:
+
+  `bundle install`
+
+And run the test suite (should be all green with pending tests):
+
+  `bundle exec rspec`
+
+If you have problems installing nmatrix, please consult the [mailing list](https://groups.google.com/forum/#!forum/sciruby-dev).
+
+While preparing your pull requests, don't forget to check your code with Rubocop:
+
+  `bundle exec rubocop`
+
+
+## Basic Development Flow
+
+1. Create a new branch with `git checkout -b <branch_name>`.
+2. Make your changes. Write tests covering every case how your feature will be used. If creating new files for tests, refer to the 'Testing' section [below](#Testing).
+3. Try out these changes with `rake pry`.
+4. Run the test suite with `rake spec`. (Alternatively you can use `guard` as described [here](https://github.com/SciRuby/daru/blob/master/CONTRIBUTING.md#testing). Also run Rubocop coding style guidelines with `rake cop`.
+5. Commit the changes with `git commit -am "briefly describe what you did"` and submit pull request.
+
+[Optional] You can run rspec for all Ruby versions at once with `rake spec run all`. But remember to first have all Ruby versions installed with `ruby spec setup`.
+
+
+## Testing
+
+
+  `bundle exec rspec`
+
+**NOTE**: Please make sure that you place test for your file at the same level and with same itermediatary directories. For example if code file lies in `lib/xyz/abc.rb` then its corresponding test should lie in `spec/xyz/abc_spec.rb`. This is to ensure correct working of Guard.
+
+
+## How daru-view is created
+
+GSoc 2017 Blog posts : [http://shekharrajak.github.io/gsoc_2017_posts/](http://shekharrajak.github.io/gsoc_2017_posts/)
+
+
+## How one can add their own library for plotting
+
+If you want to add a new library (adapter) to use it as the plotting library in `daru-view`,
+then you just need to define all the methods, that are present for [`Plot` object](https://github.com/Shekharrajak/daru-view/blob/master/lib/daru/view/plot.rb). Few main methods are `div` 
+(to get the HTML, JS code for the chart), `init_script` (to return the all the dependent css, js files for the library which is needed to run the HTML code of the chart), `export_html_file`(to export the HTML file of the chart), `init_iruby`(this method will load the dependent JS files in IRuby notebook).
+
+You can define these methods in [`daru/view/adapter`](https://github.com/Shekharrajak/daru-view/tree/master/lib/daru/view/adapters) (for reference see the other adapter).

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in daru-view.gemspec
+gemspec
+
+# Need the latest development version. Fetching it from the github repos.
+gem "daru", git: 'https://github.com/SciRuby/daru.git'
+gem "nyaplot", git: 'https://github.com/SciRuby/nyaplot.git'
+gem 'google_visualr', git: 'https://github.com/winston/google_visualr.git'
+
+gem 'daru-data_tables', git: 'https://github.com/Shekharrajak/daru-data_tables.git'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shekhar Prasad Rajak(@shekharrajak)
+
+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,287 @@
+# Daru::View
+
+[Daru](https://github.com/sciruby/daru) (Data Analysis in RUby) is a library for analysis, manipulation and visualization of data. Daru-view is for easy and interactive plotting in web application & IRuby notebook. It can work in frameworks like Rails, Sinatra, Nanoc and hopefully in others too.
+
+It is a plugin gem to Data Analysis in RUby([Daru](https://github.com/sciruby/daru)) for visualisation of data
+
+## Documentation :
+
+[http://www.rubydoc.info/github/Shekharrajak/daru-view/](http://www.rubydoc.info/github/Shekharrajak/daru-view/)
+
+[daru-view/wiki](https://github.com/Shekharrajak/daru-view/wiki)
+
+## Examples :
+
+- [IRuby notebook examples](http://nbviewer.jupyter.org/github/shekharrajak/daru-view/tree/master/spec/dummy_iruby/)
+
+- [Demo web applicatioons (Rails, Sinatra, Nanoc)](https://github.com/Shekharrajak/demo_daru-view)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'daru-view', git: 'https://github.com/Shekharrajak/daru-view.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install daru-view
+
+## Usage
+
+### Use in IRuby notebook
+
+- Create separate folder and Gemfile inside it. Add minimum these lines in it
+
+```ruby
+source "http://rubygems.org"
+
+# iruby dependencies
+gem 'rbczmq'
+gem 'ffi-rzmq'
+gem 'iruby'
+
+# fetch from the github master branch
+gem "daru", git: 'https://github.com/SciRuby/daru.git'
+gem "nyaplot", git: 'https://github.com/SciRuby/nyaplot.git'
+gem 'daru-view', :git => 'https://github.com/shekharrajak/daru-view.git'
+```
+
+- Now do `bundle install` and run `iruby notebook`
+
+- You may like to try some examples that is added in specs : [spec/dummy_iruby/](http://nbviewer.jupyter.org/github/shekharrajak/daru-view/tree/master/spec/dummy_iruby/)
+
+### Use in web application
+
+- Add this line in your Gemfile :
+```ruby
+gem 'daru-view', :git => 'https://github.com/shekharrajak/daru-view.git'
+gem "daru", git: 'https://github.com/SciRuby/daru.git'
+gem "nyaplot", git: 'https://github.com/SciRuby/nyaplot.git'
+```
+
+_Note_ : Right now, in daru-view gemspec file `daru` and `nyaplot` is not added as development_dependency. Since daru-view required the latest github version of the Daru and Nyaplot gem and we can't fetch gem from the github in the gemspec.
+
+#### Rails application
+
+- In controller, do the data analysis process using daru operations and get the DataFrame/Vectors.
+
+- Set a plotting library using e.g. `Daru::View.plotting_library = :highcharts`
+
+- In view, add the required JS files (for the plotting library), in head tag (generally) using the line , e.g. : `Daru::View.dependent_script(:highcharts)`
+
+The line `<%=raw Daru::View.dependent_script(:highcharts) %>` for rails app , must be added in the layout file of the application.
+
+- Plot library using by passing `data` and `options` :
+
+HighCharts example :
+
+```ruby
+
+# set the library, to plot charts
+Daru::View.plotting_library = :highcharts
+
+# options for the charts
+opts = {
+      chart: {defaultSeriesType: 'line'},
+      title: {
+        text: 'Solar Employment Growth by Sector, 2010-2016'
+        },
+
+      subtitle: {
+          text: 'Source: thesolarfoundation.com'
+      },
+
+      yAxis: {
+          title: {
+              text: 'Number of Employees'
+          }
+      },
+      legend: {
+          layout: 'vertical',
+          align: 'right',
+          verticalAlign: 'middle'
+      },
+
+      plotOptions: {
+          # this is not working. Find the bug
+          # series: {
+          #     pointStart: 43934
+          # }
+      },
+  }
+
+# data for the charts
+series_dt = ([{
+      name: 'Tokyo',
+      data: [7.0, 6.9, 9.5, 14.5, 18.4, 21.5, 25.2, 26.5, 23.3, 18.3, 13.9, 9.6]
+  }, {
+      name: 'London',
+      data: [3.9, 4.2, 5.7, 8.5, 11.9, 15.2, 17.0, 16.6, 14.2, 10.3, 6.6, 4.8]
+  }])
+
+# initialize
+@line_graph = Daru::View::Plot.new(series_dt, opts)
+
+# Add this line in your view file, where you want to see you graph in web application. (It will put the html code of the line graph in web page)
+
+<%=raw @line_graph.div %>
+
+# Now refresh the page, you will be able to see your graph.
+
+```
+
+
+Nyaplot example :
+
+```ruby
+
+# set the library, to plot charts (Default it is nyaplot only)
+Daru::View.plotting_library = :nyaplot
+
+
+# options for the charts
+opts = {
+  type: :bar
+}
+
+# Vector data for the charts
+data_vector = Daru::Vector.new [:a, :a, :a, :b, :b, :c], type: :category
+data_df = Daru::DataFrame.new({
+  a: [1, 2, 4, -2, 5, 23, 0],
+  b: [3, 1, 3, -6, 2, 1, 0],
+  c: ['I', 'II', 'I', 'III', 'I', 'III', 'II']
+  })
+data_df.to_category :c
+
+# initialize
+@bar_graph1 = Daru::View::Plot.new(data_vector ,opts)
+@bar_graph2 = Daru::View::Plot.new(data_df, type: :bar, x: :c)
+
+# Add this line in your view file, where you want to see you graph in web application. (It will put the html code of the line graph in web page)
+
+<%=raw @bar_graph1.div %>
+<%=raw @bar_graph2.div %>
+
+# Now refresh the page, you will be able to see your graph.
+
+```
+
+- User can try examples, that is added in spec/dummy_rails. To setup the rails app, run following commands :
+
+```
+bundle install
+bundle exec rails s
+
+```
+Now go to the http://localhost:3000/nyaplot to see the Nyaplot examples or http://localhost:3000/highcharts to see the Highcharts examples.
+
+
+#### Sinatra application
+
+
+- In view, add the required JS files (for the plotting library), in head tag (generally) using the line , e.g. : `Daru::View.dependent_script(:highcharts)`
+
+The line `<%= Daru::View.dependent_script(:highcharts) %>` for sinatra app , must be added in the layout file of the application(inside the head tag).
+
+
+```ruby
+# In side the `app.rb` user must do data analysis process using daru features and define the Daru::View::Plot class instance variables to pass into the webpages in the `view` files. You will understand this better, if you will try to run sinatra app present in the `spec/dummy_sinatra`
+
+# Add this line in your view file, where you want to see you graph in web application. (It will put the html code of the line graph in web page)
+
+<%= @line_graph.div %>
+
+<%= @bar_graph1.div %>
+<%= @bar_graph2.div %>
+
+# Now refresh the page, you will be able to see your graph.
+
+```
+
+- User can try examples, that is added in spec/dummy_sinatra. To setup the rails app, run following commands :
+
+```
+bundle install
+bundle exec ruby app.rb
+
+```
+Now go to the http://localhost:4567/nyaplot to see the Nyaplot examples or http://localhost:4567/highcharts to see the Highcharts examples.
+
+
+#### Nanoc application
+
+Most of the things similar to Rails application (syntax of the view part of the application).
+
+- User can try examples, that is added in spec/dummy_nanoc. To setup the rails app, run following commands :
+
+```
+bundle install
+bundle exec nanoc
+bundle exec nanoc view
+
+```
+Now go to the http://localhost:3000/nyaplot to see the Nyaplot examples or http://localhost:3000/highcharts to see the Highcharts examples.
+
+
+#### Live demo links
+
+Nanoc web application complie and generates the html code of the nanoc web application. So you can see the running Nanoc app here :
+
+Note : There is some problem in nyaplot (in live link. It works fine locally). Some css is not working so some styling ain't working properly. You can see it properly in local setup.
+
+[index.html](https://shekharrajak.github.io/daru-view/spec/dummy_nanoc/output/)
+
+[nyaplot](https://shekharrajak.github.io/daru-view/spec/dummy_nanoc/output/nyaplot)
+
+[highcharts](https://shekharrajak.github.io/daru-view/spec/dummy_nanoc/output/highcharts)
+
+[googlecharts](https://shekharrajak.github.io/daru-view/spec/dummy_nanoc/output/googlecharts)
+
+For now, other applications (Rails/Sinatra) you need to run it locally.
+
+
+## Update to latest js library. Additional command line
+
+  To update to the current highcharts.js directly from http://code.highcharts.com/",  you can always run
+
+    rake highcharts:update
+
+  And it will be copied to your adapters/js/highcharts_js directory.
+
+  Similarly for other libraries.
+
+  To update the all libraries Javascript file, run this command :
+
+    rake update_all
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Generally I prefer to use `bundle console` for testing few codes and experimenting the gem repo.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shekharrajak/daru-view. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+Pick a feature from the Roadmap or the issue tracker or think of your own and send me a Pull Request!
+
+For details see [CONTRIBUTING](CONTRIBUTING.md).
+
+## Acknowledgments
+
+This software has been developed by [Shekhar Prasad Rajak](https://github.com/Shekharrajak) as a product in Google Summer of Code 2017 (GSoC2017). Visit the [blog posts](http://shekharrajak.github.io/gsoc_2017_posts/) or [mailing list of SciRuby](https://groups.google.com/forum/#!forum/sciruby-dev) to see the progress of this project.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 Shekhar Prasad Rajak(@shekharrajak)