smuggle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 022c77b6c42d1bc37dcd416781313b5727f76e53
-  data.tar.gz: bedb4e4033b1a61217546482d9b452f9a6f31f2f
+  metadata.gz: b542958f709628b6a1d1fce332e11074c8e00a4c
+  data.tar.gz: 8df40c91ed11cd51f8e5b526a31f630cff4a7d9f
 SHA512:
-  metadata.gz: e3bad39a5ac3617b108ebf57a26f602d473ae0ca57627e609ad953425d40c7fc3a1942c3237cfba23fa4b1d3119b897dd454d9e138d731f591f35a555b621eea
-  data.tar.gz: 464f39496e3dacec1d1b950b76f9234652b82402bf4084fd5256638f2bab4d682588998d1d5408665c03906bd49de959d8f3c872f8ca775d72d030478d34893c
+  metadata.gz: 187563335fa1100e557bdbbddc7c155f82f755746f546e435d49ac55053ae5e60ce1d8b97cd8e6112eefad5daed8ea6fa584f4791b76e99706a5d7625d310c9e
+  data.tar.gz: 11ffc896106586065d7673f3f31dc6c9c4b4c5f60735104d507cc8f70b433d2c3806af62592f4446143ee574e5e8da7f6e6f17df9bb1c4d1f74d6ed17bc6919a

data/README.md

@@ -1,8 +1,8 @@
 # Smuggle
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smuggle`. To experiment with that code, run `bin/console` for an interactive prompt.
+Is a gem to manage exports with ease, separating the logic from the models, resulting in a much cleaner codebase. Easy to use, with familiar structure.
 
-TODO: Delete this and the text above, and describe your gem
+**Smuggle is not dependent on Rails**, you can use it on ActiveRecord models, as well as plain ruby objects and hashes.
 
 ## Installation
 
@@ -14,30 +14,99 @@ gem 'smuggle'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install smuggle
+```
+$ gem install smuggle
+```
+
+To generate the base exporter run:
+
+```
+$ rails g smuggle:install
+create app/exporters/application_exporter.rb
+```
+
+To geneate an exporter, you can run the following command:
+
+```
+$ rails g smuggle:exporter user
+create app/exporters/user_exporter.rb
+```
+
+You can also include the attributes you wish to export by running:
+
+```
+$ rails g smuggle:exporter user email username created_at
+create app/exporters/user_exporter.rb
+```
+
+## Example
+
+Inside the `user_exporter.rb` file:
+
+```ruby
+class UserExporter < ApplicationExporter
+  attributes :email, :username, :created_at
+end
+```
+
+Extra logic can be establish inside the exporter file, using the same name as the attribute:
+
+```ruby
+class UserExporter < ApplicationExporter
+  attributes :email, :username, :created_at
+
+  def created_at
+    super.created_at.strftime("%m/%d/%Y")
+  end
+end
+```
+
+If there are no attributes defined in the exporter, all the attributes of the ActiveModel record will be included.
+If it is a hash, then all values will be included.
 
 ## Usage
 
-TODO: Write usage instructions here
+Generate the csv in the desired export controller simply call:
 
-## Development
+```ruby
+class User
+  attr_accessor :name
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  def initialize(name)
+    @name = name
+  end
+end
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+class UserExporter < ApplicationExporter
+  attributes :name
+end
+
+users = [User.new('Rick Sanchez'), User.new('Morty Smith')]
+
+Smuggle::Services::Export.call(scope: users, exporter: UserExporter)
+# => "name\n" + "Rick Sanchez\n" + "Morty Smith\n"
+```
+
+Or if you are using active record, the exporter class will be automatically resolved from the scope:
+
+```ruby
+Smuggle::Services::Export.call(scope: User.all)
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smuggle. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pablocrivella/smuggle.
 
-## License
+## Todo
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+- Implement `importer` functionality
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Smuggle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/smuggle/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/smuggle/exporter/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates a exporter for a scope with the given name.
+    Additionally, you can pass the attributes you want to include in the export.
+
+Example:
+    rails generate smuggle:exporter user first_name last_name
+
+    This will create:
+
+    # app/exporter/user_exporter.rb
+
+    class UserExporter < ApplicationExporter
+      attributes :first_name, :last_name
+    end

data/lib/generators/smuggle/exporter/exporter_generator.rb

@@ -0,0 +1,13 @@
+module Smuggle
+  module Generators
+    class ExporterGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      argument :attributes, type: :array, required: false
+
+      def create_exporter
+        template 'exporter.rb', File.join('app/exporters', class_path, "#{file_name}_exporter.rb")
+      end
+    end
+  end
+end

data/lib/generators/{templates/exporters → smuggle/exporter/templates}/exporter.rb

@@ -1,4 +1,4 @@
-class <%= scope.camelize %>Exporter < ApplicationExporter
+class <%= class_name %>Exporter < ApplicationExporter
 <% if attributes -%>
   attributes <%= attributes.map { |attribute| ":#{attribute}" }.join(', ') %>
 <% end -%>

data/lib/generators/smuggle/install/USAGE

@@ -0,0 +1,3 @@
+
+Description:
+    Generates an application exporter as a starting point for your application.

data/lib/generators/smuggle/install/install_generator.rb

@@ -0,0 +1,11 @@
+module Smuggle
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_application_exporter
+        template 'application_exporter.rb', 'app/exporters/application_exporter.rb'
+      end
+    end
+  end
+end

data/lib/smuggle/version.rb

@@ -1,3 +1,3 @@
 module Smuggle
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smuggle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pablo Crivella
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,9 +127,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/generators/smuggle/smuggle_generator.rb
-- lib/generators/templates/exporters/application_exporter.rb
-- lib/generators/templates/exporters/exporter.rb
+- lib/generators/smuggle/exporter/USAGE
+- lib/generators/smuggle/exporter/exporter_generator.rb
+- lib/generators/smuggle/exporter/templates/exporter.rb
+- lib/generators/smuggle/install/USAGE
+- lib/generators/smuggle/install/install_generator.rb
+- lib/generators/smuggle/install/templates/application_exporter.rb
 - lib/smuggle.rb
 - lib/smuggle/engine.rb
 - lib/smuggle/exporter/base.rb
@@ -157,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: It Exports stuff to CSV

data/lib/generators/smuggle/smuggle_generator.rb

@@ -1,27 +0,0 @@
-module Smuggle
-  module Generators
-    class SmuggleGenerator < Rails::Generators::Base
-      namespace 'smuggle'
-
-      source_root File.expand_path('../../templates/exporters', __FILE__)
-
-      desc 'Generates an Exporter with the given NAME.' \
-           'Additionally, you can pass the attributes you want to include in the export'
-
-      argument :scope, required: true,
-        desc: 'The scope to create exporter for, e.g. users, comments'
-
-      argument :attributes, type: :array, required: false,
-        desc: 'Specify the attributes you want to export, these will also be the headers.'
-
-      def create_initializer_file
-        return if File.exist?('app/exporters/application_exporter.rb')
-        copy_file 'application_exporter.rb', 'app/exporters/application_exporter.rb'
-      end
-
-      def create_exporter
-        template 'exporter.rb', "app/exporters/#{scope.underscore}_exporter.rb"
-      end
-    end
-  end
-end